From af045c768380aeedc7c3ba35cda82dde7f0e0643 Mon Sep 17 00:00:00 2001 From: cloudant-sdks-automation <71659186+cloudant-sdks-automation@users.noreply.github.com> Date: Mon, 10 Feb 2025 10:38:01 +0000 Subject: [PATCH] Typedoc for release 0.12.1 (59de8ea) --- docs/0.12.1/assets/hierarchy.js | 1 + docs/0.12.1/assets/highlight.css | 106 + docs/0.12.1/assets/icons.js | 18 + docs/0.12.1/assets/icons.svg | 1 + docs/0.12.1/assets/main.js | 60 + docs/0.12.1/assets/navigation.js | 1 + docs/0.12.1/assets/search.js | 1 + docs/0.12.1/assets/style.css | 1611 +++++++++++++ docs/0.12.1/classes/ChangesFollower.html | 95 + docs/0.12.1/classes/CloudantV1-1.html | 2089 +++++++++++++++++ .../classes/CloudantV1.ActiveTask-1.html | 81 + .../CloudantV1.ActivityTrackerEvents-1.html | 8 + .../CloudantV1.AllDocsQueriesResult-1.html | 8 + .../classes/CloudantV1.AllDocsQuery-1.html | 34 + .../classes/CloudantV1.AllDocsResult-1.html | 11 + .../0.12.1/classes/CloudantV1.Analyzer-1.html | 14 + .../CloudantV1.AnalyzerConfiguration-1.html | 16 + .../classes/CloudantV1.ApiKeysResult-1.html | 11 + .../classes/CloudantV1.Attachment-1.html | 30 + .../0.12.1/classes/CloudantV1.BulkDocs-1.html | 11 + .../CloudantV1.BulkGetQueryDocument-1.html | 11 + .../classes/CloudantV1.BulkGetResult-1.html | 7 + .../CloudantV1.BulkGetResultDocument-1.html | 9 + .../CloudantV1.BulkGetResultItem-1.html | 9 + ...antV1.CapacityThroughputInformation-1.html | 9 + ...apacityThroughputInformationCurrent-1.html | 8 + ...CapacityThroughputInformationTarget-1.html | 8 + docs/0.12.1/classes/CloudantV1.Change-1.html | 7 + .../classes/CloudantV1.ChangesResult-1.html | 11 + .../CloudantV1.ChangesResultItem-1.html | 15 + .../CloudantV1.ContentInformationSizes-1.html | 11 + .../classes/CloudantV1.CorsInformation-1.html | 14 + ...dantV1.CurrentThroughputInformation-1.html | 7 + ...rentThroughputInformationThroughput-1.html | 11 + .../CloudantV1.DatabaseInformation-1.html | 37 + ...oudantV1.DatabaseInformationCluster-1.html | 14 + ...CloudantV1.DatabaseInformationProps-1.html | 7 + docs/0.12.1/classes/CloudantV1.DbEvent-1.html | 11 + .../classes/CloudantV1.DbUpdates-1.html | 9 + .../classes/CloudantV1.DbsInfoResult-1.html | 11 + .../classes/CloudantV1.DesignDocument-1.html | 102 + ...loudantV1.DesignDocumentInformation-1.html | 9 + .../CloudantV1.DesignDocumentOptions-1.html | 7 + .../CloudantV1.DesignDocumentViewIndex-1.html | 24 + ...dantV1.DesignDocumentViewsMapReduce-1.html | 9 + .../classes/CloudantV1.DocsResultRow-1.html | 21 + .../CloudantV1.DocsResultRowValue-1.html | 9 + .../0.12.1/classes/CloudantV1.Document-1.html | 25 + .../classes/CloudantV1.DocumentResult-1.html | 19 + .../CloudantV1.DocumentRevisionStatus-1.html | 10 + .../CloudantV1.DocumentShardInfo-1.html | 9 + .../classes/CloudantV1.ExecutionStats-1.html | 15 + .../classes/CloudantV1.ExplainResult-1.html | 60 + .../CloudantV1.ExplainResultMrArgs-1.html | 28 + .../CloudantV1.ExplainResultOpts-1.html | 33 + .../classes/CloudantV1.FindResult-1.html | 13 + .../classes/CloudantV1.IndexAnalysis-1.html | 13 + ...dantV1.IndexAnalysisExclusionReason-1.html | 24 + .../classes/CloudantV1.IndexCandidate-1.html | 9 + .../classes/CloudantV1.IndexDefinition-1.html | 60 + .../classes/CloudantV1.IndexField-1.html | 11 + .../CloudantV1.IndexInformation-1.html | 20 + .../classes/CloudantV1.IndexResult-1.html | 11 + ...antV1.IndexTextOperatorDefaultField-1.html | 10 + .../CloudantV1.IndexesInformation-1.html | 9 + .../0.12.1/classes/CloudantV1.JsonObject.html | 5 + .../CloudantV1.MembershipInformation-1.html | 9 + docs/0.12.1/classes/CloudantV1.Ok-1.html | 7 + .../CloudantV1.PartitionInformation-1.html | 17 + ...udantV1.PartitionInformationIndexes-1.html | 11 + ....PartitionInformationIndexesIndexes-1.html | 9 + ...loudantV1.PartitionInformationSizes-1.html | 9 + ...rtitionedIndexesDetailedInformation-1.html | 9 + ...antV1.PartitionedIndexesInformation-1.html | 11 + ...1.ReplicationCreateTargetParameters-1.html | 12 + .../CloudantV1.ReplicationDatabase-1.html | 11 + .../CloudantV1.ReplicationDatabaseAuth-1.html | 9 + ...dantV1.ReplicationDatabaseAuthBasic-1.html | 9 + ...oudantV1.ReplicationDatabaseAuthIam-1.html | 7 + .../CloudantV1.ReplicationDocument-1.html | 122 + .../classes/CloudantV1.Revisions-1.html | 9 + .../0.12.1/classes/CloudantV1.RevsDiff-1.html | 9 + .../CloudantV1.SchedulerDocsResult-1.html | 9 + .../CloudantV1.SchedulerDocument-1.html | 36 + .../classes/CloudantV1.SchedulerInfo-1.html | 26 + .../classes/CloudantV1.SchedulerJob-1.html | 28 + .../CloudantV1.SchedulerJobEvent-1.html | 11 + .../CloudantV1.SchedulerJobsResult-1.html | 9 + .../CloudantV1.SearchAnalyzeResult-1.html | 7 + ...loudantV1.SearchDiskSizeInformation-1.html | 9 + .../CloudantV1.SearchIndexDefinition-1.html | 35 + .../CloudantV1.SearchIndexDiskSize-1.html | 7 + .../classes/CloudantV1.SearchIndexInfo-1.html | 17 + .../CloudantV1.SearchInfoResult-1.html | 9 + .../classes/CloudantV1.SearchResult-1.html | 21 + .../CloudantV1.SearchResultProperties-1.html | 19 + .../classes/CloudantV1.SearchResultRow-1.html | 14 + .../0.12.1/classes/CloudantV1.Security-1.html | 13 + .../classes/CloudantV1.SecurityObject-1.html | 9 + .../classes/CloudantV1.SelectorHint-1.html | 11 + .../CloudantV1.ServerInformation-1.html | 15 + .../classes/CloudantV1.ServerVendor-1.html | 13 + .../CloudantV1.SessionAuthentication-1.html | 11 + .../CloudantV1.SessionInformation-1.html | 11 + .../CloudantV1.ShardsInformation-1.html | 8 + .../CloudantV1.ThroughputInformation-1.html | 14 + .../classes/CloudantV1.UpInformation-1.html | 9 + .../classes/CloudantV1.UpdatesPending-1.html | 12 + .../classes/CloudantV1.UserContext-1.html | 11 + .../classes/CloudantV1.UuidsResult-1.html | 7 + .../CloudantV1.ViewQueriesResult-1.html | 8 + .../classes/CloudantV1.ViewQuery-1.html | 65 + .../classes/CloudantV1.ViewResult-1.html | 13 + .../classes/CloudantV1.ViewResultRow-1.html | 21 + .../classes/CouchdbSessionAuthenticator.html | 30 + docs/0.12.1/classes/Stream.html | 41 + ...CloudantV1.ActiveTask.Constants.Phase.html | 7 + ...V1.ActiveTask.Constants.ProcessStatus.html | 8 + .../CloudantV1.ActiveTask.Constants.Type.html | 7 + ...ActivityTrackerEvents.Constants.Types.html | 4 + .../CloudantV1.Analyzer.Constants.Name.html | 43 + ....AnalyzerConfiguration.Constants.Name.html | 43 + .../CloudantV1.DbEvent.Constants.Type.html | 5 + ...antV1.DeleteAttachmentConstants.Batch.html | 3 + ...1.DeleteDesignDocumentConstants.Batch.html | 3 + ...udantV1.DeleteDocumentConstants.Batch.html | 3 + .../CloudantV1.DeleteIndexConstants.Type.html | 5 + ...V1.DeleteLocalDocumentConstants.Batch.html | 3 + ...eteReplicationDocumentConstants.Batch.html | 3 + ...cumentRevisionStatus.Constants.Status.html | 5 + ...plainResultMrArgs.Constants.Direction.html | 4 + ...xplainResultMrArgs.Constants.ViewType.html | 4 + ...CloudantV1.GetDbUpdatesConstants.Feed.html | 6 + ...ntV1.GetLocalDocumentConstants.Accept.html | 6 + ...ntV1.GetSchedulerDocsConstants.States.html | 9 + ...nalysisExclusionReason.Constants.Name.html | 13 + .../CloudantV1.IndexField.Constants.Type.html | 5 + ...antV1.IndexInformation.Constants.Type.html | 5 + ...oudantV1.IndexResult.Constants.Result.html | 4 + ...tActivityTrackerEventsConstants.Types.html | 4 + ...tV1.PostChangesAsStreamConstants.Feed.html | 6 + ...V1.PostChangesAsStreamConstants.Style.html | 4 + .../CloudantV1.PostChangesConstants.Feed.html | 6 + ...CloudantV1.PostChangesConstants.Style.html | 4 + ...PostDesignDocsQueriesConstants.Accept.html | 4 + ...loudantV1.PostDocumentConstants.Batch.html | 3 + ...tV1.PostDocumentConstants.ContentType.html | 6 + .../CloudantV1.PostExplainConstants.Sort.html | 4 + ...loudantV1.PostExplainConstants.Update.html | 5 + ...dantV1.PostFindAsStreamConstants.Sort.html | 4 + ...ntV1.PostFindAsStreamConstants.Update.html | 5 + .../CloudantV1.PostFindConstants.Sort.html | 4 + .../CloudantV1.PostFindConstants.Update.html | 5 + .../CloudantV1.PostIndexConstants.Type.html | 5 + ...V1.PostPartitionExplainConstants.Sort.html | 4 + ....PostPartitionExplainConstants.Update.html | 5 + ...stPartitionFindAsStreamConstants.Sort.html | 4 + ...PartitionFindAsStreamConstants.Update.html | 5 + ...antV1.PostPartitionFindConstants.Sort.html | 4 + ...tV1.PostPartitionFindConstants.Update.html | 5 + ...artitionSearchAsStreamConstants.Stale.html | 3 + ...V1.PostPartitionSearchConstants.Stale.html | 3 + ...PartitionViewAsStreamConstants.Update.html | 5 + ...tV1.PostPartitionViewConstants.Update.html | 5 + ...udantV1.PostReplicatorConstants.Batch.html | 3 + ...1.PostSearchAnalyzeConstants.Analyzer.html | 42 + ...tV1.PostSearchAsStreamConstants.Stale.html | 3 + .../CloudantV1.PostSearchConstants.Stale.html | 3 + ...ntV1.PostViewAsStreamConstants.Update.html | 5 + .../CloudantV1.PostViewConstants.Update.html | 5 + ...curityConfigurationConstants.Cloudant.html | 10 + ...ntV1.PutDesignDocumentConstants.Batch.html | 3 + ...CloudantV1.PutDocumentConstants.Batch.html | 3 + ...ntV1.PutDocumentConstants.ContentType.html | 6 + ...antV1.PutLocalDocumentConstants.Batch.html | 3 + ...PutLocalDocumentConstants.ContentType.html | 6 + ...PutReplicationDocumentConstants.Batch.html | 3 + ...udantV1.PutSecurityConstants.Cloudant.html | 10 + ...tV1.SchedulerDocument.Constants.State.html | 9 + ...loudantV1.SelectorHint.Constants.Type.html | 4 + ...dantV1.ServerVendor.Constants.Variant.html | 3 + ...dantV1.UpInformation.Constants.Status.html | 5 + ...loudantV1.UserContext.Constants.Roles.html | 10 + ...CloudantV1.ViewQuery.Constants.Update.html | 5 + docs/0.12.1/index.html | 750 ++++++ .../CloudantV1.ActiveTask.Transport.html | 35 + ...antV1.ActivityTrackerEvents.Transport.html | 2 + ...dantV1.AllDocsQueriesResult.Transport.html | 2 + .../CloudantV1.AllDocsQuery.Transport.html | 14 + .../CloudantV1.AllDocsResult.Transport.html | 4 + .../CloudantV1.Analyzer.Transport.html | 3 + ...antV1.AnalyzerConfiguration.Transport.html | 4 + .../CloudantV1.ApiKeysResult.Transport.html | 4 + .../CloudantV1.Attachment.Transport.html | 10 + .../CloudantV1.BulkDocs.Transport.html | 3 + ...dantV1.BulkGetQueryDocument.Transport.html | 4 + .../CloudantV1.BulkGetResult.Transport.html | 2 + ...antV1.BulkGetResultDocument.Transport.html | 3 + ...loudantV1.BulkGetResultItem.Transport.html | 3 + ...pacityThroughputInformation.Transport.html | 3 + ...hroughputInformationCurrent.Transport.html | 2 + ...ThroughputInformationTarget.Transport.html | 2 + .../CloudantV1.Change.Transport.html | 2 + .../CloudantV1.ChangesResult.Transport.html | 4 + ...loudantV1.ChangesResultItem.Transport.html | 6 + ...tV1.ContentInformationSizes.Transport.html | 4 + .../CloudantV1.CorsInformation.Transport.html | 4 + ...urrentThroughputInformation.Transport.html | 2 + ...ughputInformationThroughput.Transport.html | 4 + ...udantV1.DatabaseInformation.Transport.html | 16 + ....DatabaseInformationCluster.Transport.html | 5 + ...V1.DatabaseInformationProps.Transport.html | 2 + .../CloudantV1.DbEvent.Transport.html | 4 + .../CloudantV1.DbUpdates.Transport.html | 3 + .../CloudantV1.DbsInfoResult.Transport.html | 4 + .../CloudantV1.DeleteAttachmentParams.html | 16 + .../CloudantV1.DeleteDatabaseParams.html | 5 + ...CloudantV1.DeleteDesignDocumentParams.html | 15 + .../CloudantV1.DeleteDocumentParams.html | 14 + .../CloudantV1.DeleteIndexParams.html | 12 + .../CloudantV1.DeleteLocalDocumentParams.html | 10 + ...antV1.DeleteReplicationDocumentParams.html | 12 + .../CloudantV1.DesignDocument.Transport.html | 18 + ...1.DesignDocumentInformation.Transport.html | 3 + ...antV1.DesignDocumentOptions.Transport.html | 2 + ...tV1.DesignDocumentViewIndex.Transport.html | 10 + ...esignDocumentViewsMapReduce.Transport.html | 3 + .../CloudantV1.DocsResultRow.Transport.html | 9 + ...oudantV1.DocsResultRowValue.Transport.html | 3 + .../CloudantV1.Document.Transport.html | 11 + .../CloudantV1.DocumentResult.Transport.html | 8 + ...ntV1.DocumentRevisionStatus.Transport.html | 3 + ...loudantV1.DocumentShardInfo.Transport.html | 3 + .../interfaces/CloudantV1.EmptyObject.html | 2 + .../CloudantV1.ExecutionStats.Transport.html | 6 + .../CloudantV1.ExplainResult.Transport.html | 13 + ...udantV1.ExplainResultMrArgs.Transport.html | 11 + ...loudantV1.ExplainResultOpts.Transport.html | 14 + .../CloudantV1.FindResult.Transport.html | 5 + .../CloudantV1.GetActiveTasksParams.html | 3 + ...dantV1.GetActivityTrackerEventsParams.html | 3 + .../CloudantV1.GetAllDbsParams.html | 15 + .../CloudantV1.GetAttachmentParams.html | 20 + ...etCapacityThroughputInformationParams.html | 3 + .../CloudantV1.GetCorsInformationParams.html | 3 + ...GetCurrentThroughputInformationParams.html | 3 + ...oudantV1.GetDatabaseInformationParams.html | 5 + .../CloudantV1.GetDbUpdatesParams.html | 31 + ...V1.GetDesignDocumentInformationParams.html | 8 + .../CloudantV1.GetDesignDocumentParams.html | 35 + .../CloudantV1.GetDocumentAsMixedParams.html | 34 + ...CloudantV1.GetDocumentAsRelatedParams.html | 34 + .../CloudantV1.GetDocumentAsStreamParams.html | 34 + .../CloudantV1.GetDocumentParams.html | 34 + ...loudantV1.GetDocumentShardsInfoParams.html | 7 + ...loudantV1.GetIndexesInformationParams.html | 5 + .../CloudantV1.GetLocalDocumentParams.html | 18 + ...dantV1.GetMembershipInformationParams.html | 3 + ...udantV1.GetPartitionInformationParams.html | 7 + ...oudantV1.GetReplicationDocumentParams.html | 32 + .../CloudantV1.GetSchedulerDocsParams.html | 10 + ...CloudantV1.GetSchedulerDocumentParams.html | 5 + .../CloudantV1.GetSchedulerJobParams.html | 5 + .../CloudantV1.GetSchedulerJobsParams.html | 7 + .../CloudantV1.GetSearchDiskSizeParams.html | 10 + .../CloudantV1.GetSearchInfoParams.html | 10 + .../CloudantV1.GetSecurityParams.html | 5 + ...CloudantV1.GetServerInformationParams.html | 3 + ...loudantV1.GetSessionInformationParams.html | 3 + ...CloudantV1.GetShardsInformationParams.html | 5 + .../CloudantV1.GetUpInformationParams.html | 3 + .../interfaces/CloudantV1.GetUuidsParams.html | 5 + .../CloudantV1.HeadAttachmentParams.html | 15 + .../CloudantV1.HeadDatabaseParams.html | 5 + .../CloudantV1.HeadDesignDocumentParams.html | 10 + .../CloudantV1.HeadDocumentParams.html | 14 + .../CloudantV1.HeadLocalDocumentParams.html | 9 + ...udantV1.HeadReplicationDocumentParams.html | 7 + ...loudantV1.HeadSchedulerDocumentParams.html | 5 + .../CloudantV1.HeadSchedulerJobParams.html | 5 + .../CloudantV1.HeadUpInformationParams.html | 3 + .../CloudantV1.IndexAnalysis.Transport.html | 5 + ...ndexAnalysisExclusionReason.Transport.html | 2 + .../CloudantV1.IndexCandidate.Transport.html | 3 + .../CloudantV1.IndexDefinition.Transport.html | 6 + .../CloudantV1.IndexField.Transport.html | 4 + ...CloudantV1.IndexInformation.Transport.html | 6 + .../CloudantV1.IndexResult.Transport.html | 4 + ...dexTextOperatorDefaultField.Transport.html | 3 + ...oudantV1.IndexesInformation.Transport.html | 3 + ...antV1.MembershipInformation.Transport.html | 3 + .../interfaces/CloudantV1.Ok.Transport.html | 2 + ...dantV1.PartitionInformation.Transport.html | 7 + ...PartitionInformationIndexes.Transport.html | 4 + ...onInformationIndexesIndexes.Transport.html | 3 + ...1.PartitionInformationSizes.Transport.html | 3 + ...dIndexesDetailedInformation.Transport.html | 3 + ...rtitionedIndexesInformation.Transport.html | 4 + ...antV1.PostActivityTrackerEventsParams.html | 6 + .../CloudantV1.PostAllDocsAsStreamParams.html | 34 + .../CloudantV1.PostAllDocsParams.html | 34 + ...ntV1.PostAllDocsQueriesAsStreamParams.html | 8 + .../CloudantV1.PostAllDocsQueriesParams.html | 8 + .../CloudantV1.PostApiKeysParams.html | 3 + .../CloudantV1.PostBulkDocsParams.html | 7 + .../CloudantV1.PostBulkGetAsMixedParams.html | 17 + ...CloudantV1.PostBulkGetAsRelatedParams.html | 17 + .../CloudantV1.PostBulkGetAsStreamParams.html | 17 + .../CloudantV1.PostBulkGetParams.html | 17 + .../CloudantV1.PostChangesAsStreamParams.html | 113 + .../CloudantV1.PostChangesParams.html | 113 + .../CloudantV1.PostDbsInfoParams.html | 5 + .../CloudantV1.PostDesignDocsParams.html | 34 + ...loudantV1.PostDesignDocsQueriesParams.html | 10 + .../CloudantV1.PostDocumentParams.html | 12 + .../CloudantV1.PostExplainParams.html | 81 + .../CloudantV1.PostFindAsStreamParams.html | 81 + .../interfaces/CloudantV1.PostFindParams.html | 81 + .../CloudantV1.PostIndexParams.html | 22 + ...V1.PostPartitionAllDocsAsStreamParams.html | 36 + ...CloudantV1.PostPartitionAllDocsParams.html | 36 + ...CloudantV1.PostPartitionExplainParams.html | 78 + ...antV1.PostPartitionFindAsStreamParams.html | 78 + .../CloudantV1.PostPartitionFindParams.html | 78 + ...tV1.PostPartitionSearchAsStreamParams.html | 45 + .../CloudantV1.PostPartitionSearchParams.html | 45 + ...antV1.PostPartitionViewAsStreamParams.html | 66 + .../CloudantV1.PostPartitionViewParams.html | 66 + .../CloudantV1.PostReplicatorParams.html | 8 + .../CloudantV1.PostRevsDiffParams.html | 7 + .../CloudantV1.PostSearchAnalyzeParams.html | 7 + .../CloudantV1.PostSearchAsStreamParams.html | 67 + .../CloudantV1.PostSearchParams.html | 67 + .../CloudantV1.PostViewAsStreamParams.html | 70 + .../interfaces/CloudantV1.PostViewParams.html | 70 + ...udantV1.PostViewQueriesAsStreamParams.html | 13 + .../CloudantV1.PostViewQueriesParams.html | 13 + .../CloudantV1.PutAttachmentParams.html | 17 + ...CapacityThroughputConfigurationParams.html | 6 + ...utCloudantSecurityConfigurationParams.html | 13 + ...CloudantV1.PutCorsConfigurationParams.html | 12 + .../CloudantV1.PutDatabaseParams.html | 15 + .../CloudantV1.PutDesignDocumentParams.html | 23 + .../CloudantV1.PutDocumentParams.html | 24 + .../CloudantV1.PutLocalDocumentParams.html | 14 + ...oudantV1.PutReplicationDocumentParams.html | 20 + .../CloudantV1.PutSecurityParams.html | 13 + ...ationCreateTargetParameters.Transport.html | 4 + ...udantV1.ReplicationDatabase.Transport.html | 4 + ...tV1.ReplicationDatabaseAuth.Transport.html | 3 + ...eplicationDatabaseAuthBasic.Transport.html | 3 + ....ReplicationDatabaseAuthIam.Transport.html | 2 + ...udantV1.ReplicationDocument.Transport.html | 36 + .../interfaces/CloudantV1.Response.html | 6 + .../CloudantV1.Revisions.Transport.html | 3 + .../CloudantV1.RevsDiff.Transport.html | 3 + ...udantV1.SchedulerDocsResult.Transport.html | 3 + ...loudantV1.SchedulerDocument.Transport.html | 14 + .../CloudantV1.SchedulerInfo.Transport.html | 11 + .../CloudantV1.SchedulerJob.Transport.html | 12 + ...loudantV1.SchedulerJobEvent.Transport.html | 4 + ...udantV1.SchedulerJobsResult.Transport.html | 3 + ...udantV1.SearchAnalyzeResult.Transport.html | 2 + ...1.SearchDiskSizeInformation.Transport.html | 3 + ...antV1.SearchIndexDefinition.Transport.html | 3 + ...udantV1.SearchIndexDiskSize.Transport.html | 2 + .../CloudantV1.SearchIndexInfo.Transport.html | 7 + ...CloudantV1.SearchInfoResult.Transport.html | 3 + .../CloudantV1.SearchResult.Transport.html | 8 + ...ntV1.SearchResultProperties.Transport.html | 7 + .../CloudantV1.SearchResultRow.Transport.html | 5 + .../CloudantV1.Security.Transport.html | 5 + .../CloudantV1.SecurityObject.Transport.html | 3 + .../CloudantV1.SelectorHint.Transport.html | 4 + ...loudantV1.ServerInformation.Transport.html | 6 + .../CloudantV1.ServerVendor.Transport.html | 5 + ...antV1.SessionAuthentication.Transport.html | 4 + ...oudantV1.SessionInformation.Transport.html | 4 + ...loudantV1.ShardsInformation.Transport.html | 2 + ...antV1.ThroughputInformation.Transport.html | 5 + .../CloudantV1.UpInformation.Transport.html | 3 + .../CloudantV1.UpdatesPending.Transport.html | 4 + .../CloudantV1.UserContext.Transport.html | 4 + .../CloudantV1.UuidsResult.Transport.html | 2 + ...loudantV1.ViewQueriesResult.Transport.html | 2 + .../CloudantV1.ViewQuery.Transport.html | 21 + .../CloudantV1.ViewResult.Transport.html | 4 + .../CloudantV1.ViewResultRow.Transport.html | 9 + docs/0.12.1/media/KNOWN_ISSUES.md | 113 + docs/0.12.1/modules.html | 1 + .../CloudantV1.ActiveTask.Constants.html | 1 + .../0.12.1/modules/CloudantV1.ActiveTask.html | 1 + ...antV1.ActivityTrackerEvents.Constants.html | 1 + .../CloudantV1.ActivityTrackerEvents.html | 1 + .../CloudantV1.AllDocsQueriesResult.html | 1 + .../modules/CloudantV1.AllDocsQuery.html | 1 + .../modules/CloudantV1.AllDocsResult.html | 1 + .../CloudantV1.Analyzer.Constants.html | 1 + docs/0.12.1/modules/CloudantV1.Analyzer.html | 1 + ...antV1.AnalyzerConfiguration.Constants.html | 1 + .../CloudantV1.AnalyzerConfiguration.html | 1 + .../modules/CloudantV1.ApiKeysResult.html | 1 + .../0.12.1/modules/CloudantV1.Attachment.html | 1 + docs/0.12.1/modules/CloudantV1.BulkDocs.html | 1 + .../CloudantV1.BulkGetQueryDocument.html | 1 + .../modules/CloudantV1.BulkGetResult.html | 1 + .../CloudantV1.BulkGetResultDocument.html | 1 + .../modules/CloudantV1.BulkGetResultItem.html | 1 + ...udantV1.CapacityThroughputInformation.html | 1 + ....CapacityThroughputInformationCurrent.html | 1 + ...1.CapacityThroughputInformationTarget.html | 1 + docs/0.12.1/modules/CloudantV1.Change.html | 1 + .../modules/CloudantV1.ChangesResult.html | 1 + .../modules/CloudantV1.ChangesResultItem.html | 1 + .../CloudantV1.ContentInformationSizes.html | 1 + .../modules/CloudantV1.CorsInformation.html | 1 + ...oudantV1.CurrentThroughputInformation.html | 1 + ...urrentThroughputInformationThroughput.html | 1 + .../CloudantV1.DatabaseInformation.html | 1 + ...CloudantV1.DatabaseInformationCluster.html | 1 + .../CloudantV1.DatabaseInformationProps.html | 1 + .../modules/CloudantV1.DbEvent.Constants.html | 1 + docs/0.12.1/modules/CloudantV1.DbEvent.html | 1 + docs/0.12.1/modules/CloudantV1.DbUpdates.html | 1 + .../modules/CloudantV1.DbsInfoResult.html | 1 + .../CloudantV1.DeleteAttachmentConstants.html | 2 + ...udantV1.DeleteDesignDocumentConstants.html | 2 + .../CloudantV1.DeleteDocumentConstants.html | 2 + .../CloudantV1.DeleteIndexConstants.html | 2 + ...oudantV1.DeleteLocalDocumentConstants.html | 2 + ...V1.DeleteReplicationDocumentConstants.html | 2 + .../modules/CloudantV1.DesignDocument.html | 1 + .../CloudantV1.DesignDocumentInformation.html | 1 + .../CloudantV1.DesignDocumentOptions.html | 1 + .../CloudantV1.DesignDocumentViewIndex.html | 1 + ...oudantV1.DesignDocumentViewsMapReduce.html | 1 + .../modules/CloudantV1.DocsResultRow.html | 1 + .../CloudantV1.DocsResultRowValue.html | 1 + docs/0.12.1/modules/CloudantV1.Document.html | 1 + .../modules/CloudantV1.DocumentResult.html | 1 + ...ntV1.DocumentRevisionStatus.Constants.html | 1 + .../CloudantV1.DocumentRevisionStatus.html | 1 + .../modules/CloudantV1.DocumentShardInfo.html | 1 + .../modules/CloudantV1.ExecutionStats.html | 1 + .../modules/CloudantV1.ExplainResult.html | 1 + ...udantV1.ExplainResultMrArgs.Constants.html | 1 + .../CloudantV1.ExplainResultMrArgs.html | 1 + .../modules/CloudantV1.ExplainResultOpts.html | 1 + .../0.12.1/modules/CloudantV1.FindResult.html | 1 + .../CloudantV1.GetDbUpdatesConstants.html | 2 + .../CloudantV1.GetLocalDocumentConstants.html | 2 + .../CloudantV1.GetSchedulerDocsConstants.html | 2 + .../modules/CloudantV1.IndexAnalysis.html | 1 + ...ndexAnalysisExclusionReason.Constants.html | 1 + ...oudantV1.IndexAnalysisExclusionReason.html | 1 + .../modules/CloudantV1.IndexCandidate.html | 1 + .../modules/CloudantV1.IndexDefinition.html | 1 + .../CloudantV1.IndexField.Constants.html | 1 + .../0.12.1/modules/CloudantV1.IndexField.html | 1 + ...CloudantV1.IndexInformation.Constants.html | 1 + .../modules/CloudantV1.IndexInformation.html | 1 + .../CloudantV1.IndexResult.Constants.html | 1 + .../modules/CloudantV1.IndexResult.html | 1 + ...udantV1.IndexTextOperatorDefaultField.html | 1 + .../CloudantV1.IndexesInformation.html | 1 + .../CloudantV1.MembershipInformation.html | 1 + docs/0.12.1/modules/CloudantV1.Ok.html | 1 + .../CloudantV1.PartitionInformation.html | 1 + ...loudantV1.PartitionInformationIndexes.html | 1 + ...V1.PartitionInformationIndexesIndexes.html | 1 + .../CloudantV1.PartitionInformationSizes.html | 1 + ...PartitionedIndexesDetailedInformation.html | 1 + ...udantV1.PartitionedIndexesInformation.html | 1 + ...V1.PostActivityTrackerEventsConstants.html | 2 + ...oudantV1.PostChangesAsStreamConstants.html | 2 + .../CloudantV1.PostChangesConstants.html | 2 + ...dantV1.PostDesignDocsQueriesConstants.html | 2 + .../CloudantV1.PostDocumentConstants.html | 2 + .../CloudantV1.PostExplainConstants.html | 2 + .../CloudantV1.PostFindAsStreamConstants.html | 2 + .../modules/CloudantV1.PostFindConstants.html | 2 + .../CloudantV1.PostIndexConstants.html | 2 + ...udantV1.PostPartitionExplainConstants.html | 2 + ...V1.PostPartitionFindAsStreamConstants.html | 2 + ...CloudantV1.PostPartitionFindConstants.html | 2 + ....PostPartitionSearchAsStreamConstants.html | 2 + ...oudantV1.PostPartitionSearchConstants.html | 2 + ...V1.PostPartitionViewAsStreamConstants.html | 2 + ...CloudantV1.PostPartitionViewConstants.html | 2 + .../CloudantV1.PostReplicatorConstants.html | 2 + ...CloudantV1.PostSearchAnalyzeConstants.html | 2 + ...loudantV1.PostSearchAsStreamConstants.html | 2 + .../CloudantV1.PostSearchConstants.html | 2 + .../CloudantV1.PostViewAsStreamConstants.html | 2 + .../modules/CloudantV1.PostViewConstants.html | 2 + ...loudantSecurityConfigurationConstants.html | 2 + ...CloudantV1.PutDesignDocumentConstants.html | 2 + .../CloudantV1.PutDocumentConstants.html | 2 + .../CloudantV1.PutLocalDocumentConstants.html | 2 + ...antV1.PutReplicationDocumentConstants.html | 2 + .../CloudantV1.PutSecurityConstants.html | 2 + ...tV1.ReplicationCreateTargetParameters.html | 1 + .../CloudantV1.ReplicationDatabase.html | 1 + .../CloudantV1.ReplicationDatabaseAuth.html | 1 + ...oudantV1.ReplicationDatabaseAuthBasic.html | 1 + ...CloudantV1.ReplicationDatabaseAuthIam.html | 1 + .../CloudantV1.ReplicationDocument.html | 1 + docs/0.12.1/modules/CloudantV1.Revisions.html | 1 + docs/0.12.1/modules/CloudantV1.RevsDiff.html | 1 + .../CloudantV1.SchedulerDocsResult.html | 1 + ...loudantV1.SchedulerDocument.Constants.html | 1 + .../modules/CloudantV1.SchedulerDocument.html | 1 + .../modules/CloudantV1.SchedulerInfo.html | 1 + .../modules/CloudantV1.SchedulerJob.html | 1 + .../modules/CloudantV1.SchedulerJobEvent.html | 1 + .../CloudantV1.SchedulerJobsResult.html | 1 + .../CloudantV1.SearchAnalyzeResult.html | 1 + .../CloudantV1.SearchDiskSizeInformation.html | 1 + .../CloudantV1.SearchIndexDefinition.html | 1 + .../CloudantV1.SearchIndexDiskSize.html | 1 + .../modules/CloudantV1.SearchIndexInfo.html | 1 + .../modules/CloudantV1.SearchInfoResult.html | 1 + .../modules/CloudantV1.SearchResult.html | 1 + .../CloudantV1.SearchResultProperties.html | 1 + .../modules/CloudantV1.SearchResultRow.html | 1 + docs/0.12.1/modules/CloudantV1.Security.html | 1 + .../modules/CloudantV1.SecurityObject.html | 1 + .../CloudantV1.SelectorHint.Constants.html | 1 + .../modules/CloudantV1.SelectorHint.html | 1 + .../modules/CloudantV1.ServerInformation.html | 1 + .../CloudantV1.ServerVendor.Constants.html | 1 + .../modules/CloudantV1.ServerVendor.html | 1 + .../CloudantV1.SessionAuthentication.html | 1 + .../CloudantV1.SessionInformation.html | 1 + .../modules/CloudantV1.ShardsInformation.html | 1 + .../CloudantV1.ThroughputInformation.html | 1 + .../CloudantV1.UpInformation.Constants.html | 1 + .../modules/CloudantV1.UpInformation.html | 1 + .../modules/CloudantV1.UpdatesPending.html | 1 + .../CloudantV1.UserContext.Constants.html | 1 + .../modules/CloudantV1.UserContext.html | 1 + .../modules/CloudantV1.UuidsResult.html | 1 + .../modules/CloudantV1.ViewQueriesResult.html | 1 + .../CloudantV1.ViewQuery.Constants.html | 1 + docs/0.12.1/modules/CloudantV1.ViewQuery.html | 1 + .../0.12.1/modules/CloudantV1.ViewResult.html | 1 + .../modules/CloudantV1.ViewResultRow.html | 1 + docs/0.12.1/modules/CloudantV1.html | 4 + docs/0.12.1/types/CloudantV1.Callback.html | 2 + .../CouchdbSessionAuthenticatorOptions.html | 4 + docs/latest | 2 +- index.html | 1 + 552 files changed, 10247 insertions(+), 1 deletion(-) create mode 100644 docs/0.12.1/assets/hierarchy.js create mode 100644 docs/0.12.1/assets/highlight.css create mode 100644 docs/0.12.1/assets/icons.js create mode 100644 docs/0.12.1/assets/icons.svg create mode 100644 docs/0.12.1/assets/main.js create mode 100644 docs/0.12.1/assets/navigation.js create mode 100644 docs/0.12.1/assets/search.js create mode 100644 docs/0.12.1/assets/style.css create mode 100644 docs/0.12.1/classes/ChangesFollower.html create mode 100644 docs/0.12.1/classes/CloudantV1-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ActiveTask-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ActivityTrackerEvents-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.AllDocsQueriesResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.AllDocsQuery-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.AllDocsResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Analyzer-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.AnalyzerConfiguration-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ApiKeysResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Attachment-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.BulkDocs-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.BulkGetQueryDocument-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.BulkGetResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.BulkGetResultDocument-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.BulkGetResultItem-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CapacityThroughputInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationCurrent-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationTarget-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Change-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ChangesResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ChangesResultItem-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ContentInformationSizes-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CorsInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CurrentThroughputInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.CurrentThroughputInformationThroughput-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DatabaseInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DatabaseInformationCluster-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DatabaseInformationProps-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DbEvent-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DbUpdates-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DbsInfoResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DesignDocument-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DesignDocumentInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DesignDocumentOptions-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DesignDocumentViewIndex-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DesignDocumentViewsMapReduce-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DocsResultRow-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DocsResultRowValue-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Document-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DocumentResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DocumentRevisionStatus-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.DocumentShardInfo-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ExecutionStats-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ExplainResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ExplainResultMrArgs-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ExplainResultOpts-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.FindResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexAnalysis-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexAnalysisExclusionReason-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexCandidate-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexDefinition-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexField-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexTextOperatorDefaultField-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.IndexesInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.JsonObject.html create mode 100644 docs/0.12.1/classes/CloudantV1.MembershipInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Ok-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionInformationIndexes-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionInformationIndexesIndexes-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionInformationSizes-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionedIndexesDetailedInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.PartitionedIndexesInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationCreateTargetParameters-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationDatabase-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuth-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthBasic-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthIam-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ReplicationDocument-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Revisions-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.RevsDiff-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerDocsResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerDocument-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerInfo-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerJob-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerJobEvent-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SchedulerJobsResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchAnalyzeResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchDiskSizeInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchIndexDefinition-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchIndexDiskSize-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchIndexInfo-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchInfoResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchResultProperties-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SearchResultRow-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.Security-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SecurityObject-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SelectorHint-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ServerInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ServerVendor-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SessionAuthentication-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.SessionInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ShardsInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ThroughputInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.UpInformation-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.UpdatesPending-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.UserContext-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.UuidsResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ViewQueriesResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ViewQuery-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ViewResult-1.html create mode 100644 docs/0.12.1/classes/CloudantV1.ViewResultRow-1.html create mode 100644 docs/0.12.1/classes/CouchdbSessionAuthenticator.html create mode 100644 docs/0.12.1/classes/Stream.html create mode 100644 docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Phase.html create mode 100644 docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.ProcessStatus.html create mode 100644 docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.ActivityTrackerEvents.Constants.Types.html create mode 100644 docs/0.12.1/enums/CloudantV1.Analyzer.Constants.Name.html create mode 100644 docs/0.12.1/enums/CloudantV1.AnalyzerConfiguration.Constants.Name.html create mode 100644 docs/0.12.1/enums/CloudantV1.DbEvent.Constants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteAttachmentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteDesignDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteIndexConstants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteLocalDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.DeleteReplicationDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.DocumentRevisionStatus.Constants.Status.html create mode 100644 docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.Direction.html create mode 100644 docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.ViewType.html create mode 100644 docs/0.12.1/enums/CloudantV1.GetDbUpdatesConstants.Feed.html create mode 100644 docs/0.12.1/enums/CloudantV1.GetLocalDocumentConstants.Accept.html create mode 100644 docs/0.12.1/enums/CloudantV1.GetSchedulerDocsConstants.States.html create mode 100644 docs/0.12.1/enums/CloudantV1.IndexAnalysisExclusionReason.Constants.Name.html create mode 100644 docs/0.12.1/enums/CloudantV1.IndexField.Constants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.IndexInformation.Constants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.IndexResult.Constants.Result.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostActivityTrackerEventsConstants.Types.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Feed.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Style.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostChangesConstants.Feed.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostChangesConstants.Style.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostDesignDocsQueriesConstants.Accept.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostDocumentConstants.ContentType.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostExplainConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostExplainConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostFindConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostFindConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostIndexConstants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Sort.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionSearchAsStreamConstants.Stale.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionSearchConstants.Stale.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionViewAsStreamConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostPartitionViewConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostReplicatorConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostSearchAnalyzeConstants.Analyzer.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostSearchAsStreamConstants.Stale.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostSearchConstants.Stale.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostViewAsStreamConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PostViewConstants.Update.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutCloudantSecurityConfigurationConstants.Cloudant.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutDesignDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutDocumentConstants.ContentType.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.ContentType.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutReplicationDocumentConstants.Batch.html create mode 100644 docs/0.12.1/enums/CloudantV1.PutSecurityConstants.Cloudant.html create mode 100644 docs/0.12.1/enums/CloudantV1.SchedulerDocument.Constants.State.html create mode 100644 docs/0.12.1/enums/CloudantV1.SelectorHint.Constants.Type.html create mode 100644 docs/0.12.1/enums/CloudantV1.ServerVendor.Constants.Variant.html create mode 100644 docs/0.12.1/enums/CloudantV1.UpInformation.Constants.Status.html create mode 100644 docs/0.12.1/enums/CloudantV1.UserContext.Constants.Roles.html create mode 100644 docs/0.12.1/enums/CloudantV1.ViewQuery.Constants.Update.html create mode 100644 docs/0.12.1/index.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ActiveTask.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ActivityTrackerEvents.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.AllDocsQueriesResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.AllDocsQuery.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.AllDocsResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Analyzer.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.AnalyzerConfiguration.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ApiKeysResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Attachment.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.BulkDocs.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.BulkGetQueryDocument.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.BulkGetResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.BulkGetResultDocument.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.BulkGetResultItem.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationCurrent.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationTarget.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Change.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ChangesResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ChangesResultItem.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ContentInformationSizes.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CorsInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformationThroughput.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DatabaseInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DatabaseInformationCluster.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DatabaseInformationProps.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DbEvent.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DbUpdates.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DbsInfoResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteAttachmentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteDatabaseParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteDesignDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteIndexParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteLocalDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DeleteReplicationDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DesignDocument.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DesignDocumentInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DesignDocumentOptions.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewIndex.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewsMapReduce.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DocsResultRow.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DocsResultRowValue.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Document.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DocumentResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DocumentRevisionStatus.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.DocumentShardInfo.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.EmptyObject.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ExecutionStats.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ExplainResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ExplainResultMrArgs.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ExplainResultOpts.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.FindResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetActiveTasksParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetActivityTrackerEventsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetAllDbsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetAttachmentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetCapacityThroughputInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetCorsInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetCurrentThroughputInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDatabaseInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDbUpdatesParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDocumentAsMixedParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDocumentAsRelatedParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDocumentAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetDocumentShardsInfoParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetIndexesInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetLocalDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetMembershipInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetPartitionInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetReplicationDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSearchDiskSizeParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSearchInfoParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSecurityParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetServerInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetSessionInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetShardsInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetUpInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.GetUuidsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadAttachmentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadDatabaseParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadDesignDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadLocalDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadReplicationDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadSchedulerDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadSchedulerJobParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.HeadUpInformationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexAnalysis.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexAnalysisExclusionReason.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexCandidate.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexDefinition.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexField.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexTextOperatorDefaultField.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.IndexesInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.MembershipInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Ok.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexes.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexesIndexes.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionInformationSizes.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesDetailedInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostActivityTrackerEventsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostAllDocsAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostAllDocsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostApiKeysParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostBulkDocsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsMixedParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsRelatedParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostBulkGetParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostChangesAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostChangesParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostDbsInfoParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostDesignDocsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostDesignDocsQueriesParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostExplainParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostFindAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostFindParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostIndexParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionExplainParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionFindAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionFindParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionViewAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostPartitionViewParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostReplicatorParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostRevsDiffParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostSearchAnalyzeParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostSearchAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostSearchParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostViewAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostViewParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostViewQueriesAsStreamParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PostViewQueriesParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutAttachmentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutCapacityThroughputConfigurationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutCloudantSecurityConfigurationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutCorsConfigurationParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutDatabaseParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutDesignDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutLocalDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutReplicationDocumentParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.PutSecurityParams.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationCreateTargetParameters.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationDatabase.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuth.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthBasic.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthIam.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ReplicationDocument.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Response.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Revisions.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.RevsDiff.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerDocsResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerDocument.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerInfo.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerJob.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerJobEvent.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SchedulerJobsResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchAnalyzeResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchDiskSizeInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchIndexDefinition.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchIndexDiskSize.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchIndexInfo.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchInfoResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchResultProperties.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SearchResultRow.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.Security.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SecurityObject.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SelectorHint.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ServerInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ServerVendor.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SessionAuthentication.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.SessionInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ShardsInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ThroughputInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.UpInformation.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.UpdatesPending.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.UserContext.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.UuidsResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ViewQueriesResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ViewQuery.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ViewResult.Transport.html create mode 100644 docs/0.12.1/interfaces/CloudantV1.ViewResultRow.Transport.html create mode 100644 docs/0.12.1/media/KNOWN_ISSUES.md create mode 100644 docs/0.12.1/modules.html create mode 100644 docs/0.12.1/modules/CloudantV1.ActiveTask.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ActiveTask.html create mode 100644 docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.html create mode 100644 docs/0.12.1/modules/CloudantV1.AllDocsQueriesResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.AllDocsQuery.html create mode 100644 docs/0.12.1/modules/CloudantV1.AllDocsResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.Analyzer.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.Analyzer.html create mode 100644 docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.html create mode 100644 docs/0.12.1/modules/CloudantV1.ApiKeysResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.Attachment.html create mode 100644 docs/0.12.1/modules/CloudantV1.BulkDocs.html create mode 100644 docs/0.12.1/modules/CloudantV1.BulkGetQueryDocument.html create mode 100644 docs/0.12.1/modules/CloudantV1.BulkGetResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.BulkGetResultDocument.html create mode 100644 docs/0.12.1/modules/CloudantV1.BulkGetResultItem.html create mode 100644 docs/0.12.1/modules/CloudantV1.CapacityThroughputInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationCurrent.html create mode 100644 docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationTarget.html create mode 100644 docs/0.12.1/modules/CloudantV1.Change.html create mode 100644 docs/0.12.1/modules/CloudantV1.ChangesResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.ChangesResultItem.html create mode 100644 docs/0.12.1/modules/CloudantV1.ContentInformationSizes.html create mode 100644 docs/0.12.1/modules/CloudantV1.CorsInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.CurrentThroughputInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.CurrentThroughputInformationThroughput.html create mode 100644 docs/0.12.1/modules/CloudantV1.DatabaseInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.DatabaseInformationCluster.html create mode 100644 docs/0.12.1/modules/CloudantV1.DatabaseInformationProps.html create mode 100644 docs/0.12.1/modules/CloudantV1.DbEvent.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DbEvent.html create mode 100644 docs/0.12.1/modules/CloudantV1.DbUpdates.html create mode 100644 docs/0.12.1/modules/CloudantV1.DbsInfoResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteAttachmentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteDesignDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteIndexConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteLocalDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DeleteReplicationDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DesignDocument.html create mode 100644 docs/0.12.1/modules/CloudantV1.DesignDocumentInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.DesignDocumentOptions.html create mode 100644 docs/0.12.1/modules/CloudantV1.DesignDocumentViewIndex.html create mode 100644 docs/0.12.1/modules/CloudantV1.DesignDocumentViewsMapReduce.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocsResultRow.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocsResultRowValue.html create mode 100644 docs/0.12.1/modules/CloudantV1.Document.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocumentResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.html create mode 100644 docs/0.12.1/modules/CloudantV1.DocumentShardInfo.html create mode 100644 docs/0.12.1/modules/CloudantV1.ExecutionStats.html create mode 100644 docs/0.12.1/modules/CloudantV1.ExplainResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.html create mode 100644 docs/0.12.1/modules/CloudantV1.ExplainResultOpts.html create mode 100644 docs/0.12.1/modules/CloudantV1.FindResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.GetDbUpdatesConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.GetLocalDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.GetSchedulerDocsConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexAnalysis.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexCandidate.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexDefinition.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexField.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexField.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexInformation.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexResult.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexTextOperatorDefaultField.html create mode 100644 docs/0.12.1/modules/CloudantV1.IndexesInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.MembershipInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.Ok.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionInformationIndexes.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionInformationIndexesIndexes.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionInformationSizes.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionedIndexesDetailedInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.PartitionedIndexesInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostActivityTrackerEventsConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostChangesAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostChangesConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostDesignDocsQueriesConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostExplainConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostFindAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostFindConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostIndexConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionExplainConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionFindAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionFindConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionSearchAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionSearchConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionViewAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostPartitionViewConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostReplicatorConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostSearchAnalyzeConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostSearchAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostSearchConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostViewAsStreamConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PostViewConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutCloudantSecurityConfigurationConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutDesignDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutLocalDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutReplicationDocumentConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.PutSecurityConstants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationCreateTargetParameters.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationDatabase.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuth.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthBasic.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthIam.html create mode 100644 docs/0.12.1/modules/CloudantV1.ReplicationDocument.html create mode 100644 docs/0.12.1/modules/CloudantV1.Revisions.html create mode 100644 docs/0.12.1/modules/CloudantV1.RevsDiff.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerDocsResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerDocument.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerDocument.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerInfo.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerJob.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerJobEvent.html create mode 100644 docs/0.12.1/modules/CloudantV1.SchedulerJobsResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchAnalyzeResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchDiskSizeInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchIndexDefinition.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchIndexDiskSize.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchIndexInfo.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchInfoResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchResultProperties.html create mode 100644 docs/0.12.1/modules/CloudantV1.SearchResultRow.html create mode 100644 docs/0.12.1/modules/CloudantV1.Security.html create mode 100644 docs/0.12.1/modules/CloudantV1.SecurityObject.html create mode 100644 docs/0.12.1/modules/CloudantV1.SelectorHint.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.SelectorHint.html create mode 100644 docs/0.12.1/modules/CloudantV1.ServerInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.ServerVendor.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ServerVendor.html create mode 100644 docs/0.12.1/modules/CloudantV1.SessionAuthentication.html create mode 100644 docs/0.12.1/modules/CloudantV1.SessionInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.ShardsInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.ThroughputInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.UpInformation.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.UpInformation.html create mode 100644 docs/0.12.1/modules/CloudantV1.UpdatesPending.html create mode 100644 docs/0.12.1/modules/CloudantV1.UserContext.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.UserContext.html create mode 100644 docs/0.12.1/modules/CloudantV1.UuidsResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.ViewQueriesResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.ViewQuery.Constants.html create mode 100644 docs/0.12.1/modules/CloudantV1.ViewQuery.html create mode 100644 docs/0.12.1/modules/CloudantV1.ViewResult.html create mode 100644 docs/0.12.1/modules/CloudantV1.ViewResultRow.html create mode 100644 docs/0.12.1/modules/CloudantV1.html create mode 100644 docs/0.12.1/types/CloudantV1.Callback.html create mode 100644 docs/0.12.1/types/CouchdbSessionAuthenticatorOptions.html diff --git a/docs/0.12.1/assets/hierarchy.js b/docs/0.12.1/assets/hierarchy.js new file mode 100644 index 000000000..88636f05d --- /dev/null +++ b/docs/0.12.1/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm" \ No newline at end of file diff --git a/docs/0.12.1/assets/highlight.css b/docs/0.12.1/assets/highlight.css new file mode 100644 index 000000000..24e2b06e7 --- /dev/null +++ b/docs/0.12.1/assets/highlight.css @@ -0,0 +1,106 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #267F99; + --dark-hl-6: #4EC9B0; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; + --light-hl-8: #0070C1; + --dark-hl-8: #4FC1FF; + --light-hl-9: #098658; + --dark-hl-9: #B5CEA8; + --light-hl-10: #EE0000; + --dark-hl-10: #D7BA7D; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +pre, code { background: var(--code-background); } diff --git a/docs/0.12.1/assets/icons.js b/docs/0.12.1/assets/icons.js new file mode 100644 index 000000000..58882d76d --- /dev/null +++ b/docs/0.12.1/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/0.12.1/assets/icons.svg b/docs/0.12.1/assets/icons.svg new file mode 100644 index 000000000..50ad5799d --- /dev/null +++ b/docs/0.12.1/assets/icons.svg @@ -0,0 +1 @@ +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/0.12.1/assets/main.js b/docs/0.12.1/assets/main.js new file mode 100644 index 000000000..2363f64c2 --- /dev/null +++ b/docs/0.12.1/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; +"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,c],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function A(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await A(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var H="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,be=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(be?"is-mobile":"not-mobile");be&&"ontouchstart"in document.documentElement&&(Xe=!0,H="touchstart",Ee="touchmove",B="touchend");document.addEventListener(H,t=>{ie=!0,D=!1;let e=H=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=H=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(H,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await A(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await A(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(_e(e,i,n))}function _e(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=_e(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var Oe=document.getElementById("tsd-theme");Oe&&Se(Oe);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/0.12.1/assets/navigation.js b/docs/0.12.1/assets/navigation.js new file mode 100644 index 000000000..35304fcb8 --- /dev/null +++ b/docs/0.12.1/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "eJy9Xdt23LYV/Rc9pxd7NW2aN0eyE6V15Uq2X7L6QM3AGtbUcBYvjpWs/nt5J0Ac4OyDAfSWyGfvffYhCJIYXH75/aJRX5uL7y8ui7LdZ8fm44uLby5OWXPo/vZY7ttC1X9a/+2Ph+ax6AI+58f9xfd/+eZid8iLfaWOF9//slC92jX5F/U+qz97qdYwiPWyPNZNh6xR0gUA0b87ZLVaqdWxfeSJB5BJ/93/vlk5q3Kn6vquyZq2FnPrYLfG+6eTOO0es2X8j85ZZcf6VFbNSpwfG1V9ynbOai8Yk/jlt381qAdE3jx14bvPqnr9RUFXdIuI3WIsflnj6QvKXmCPxoCPd0UsJfTiFMVVuav/3aoqV/Wtqtui8deOAGAFg/1QCnI7T6iNp2TpPwnTxsufsO7Cgh+z4uk3VfmTnoJi3sIzpeyu/Vf26O06bdYeEec2nbmFle1S+ZQ/tFXW5OURqomBSFBzkz/JBXBJRL8aphB6aU75P9QTdLvqkZFvV4Mazbxpst3hsXtC+NNewiLnvPKCCf/QFp/7Xsmb7hwUN9mFVZDqj6oZOv4O17JVpgDxLVgKMjtAIzcikxiQNXIDJLkSJiKhk7OuxXWjHnE3fXRCJwM96OIyO2W7/kX1UJXtw+HUNtfHT2X1yD/ZvMi47vxSMZxetlXFNUiE4Bl9z4ox7L/Pqgd1hvsR/4zmJ0HU+yE7Pii/vSEksoORU5Qk8gJjRKZIWfgCY4DYntCKTuhA1BOWHd9Rb2R3+W/K/5LjwER25BCBfVU13KebsbF9mORo/mM/F/CA8gAjO/MpRbC5/jHY8PrH57OuaYJFuMqa7D6rFXqJifi49iiBcC+XRVs3zLiMG5bc2awTbvBdVZ78PaYLlNzcqIJaux9GbP1OxpiIYzkzo3zQ2zN6Y5NG+9lhpoaLOnT/wAuOERm5ZRjUcOYfTvusYV4GlqjYGc+0aLaqUI1ah3XAxudCQW5+yJrdwdcKnewD0tccR+iVqvOH4/yNLrHkQEa05VJArYWYSmkn1Mj1ca++SlyYgCi9HcXLdXgj6J/lLitCrgUNjHhBHALgVblVpyLfDc/AEHc+eESPXhnAqX4HMq700MhdtckN99c6Cn71daFSWgp5DTYIbk49lmt3BCKlq1kiyNHHXP069DcCTwsmpatVJNhX/TY73ap9u/OPnfmAqR1qSqjN5ff02/JXvy89MrIRgzok849Z0TKXxQpP6GHkx40AHXWaLlraOU/xyFeLEZombeF3y4L6ktf9uOFmBpzXhA6J+ZFLC8jeKdipfKwKPZ8v7DOY1hJeo7tDVu375ytUvSU6TTNb6UEXr7+qXdtM5v0NwAyNm/+GG07+VGT5EbjFjcjYqevUIZm/rV5VD1ztrfiItzbFLruvr/JK7cxXX+vW9qssDO6puv1rA/MZ6deYCaL0HpRUyNXvXmIFV6ePTth+B3rQxZvur8Ctt4bFzVvjBRP+UTXLmBx2Y5AIyMYbpfaedkoT9yBf2+xQAYMdThS4GGGnTo3fioN+hDKG7nYH1adc9W+lsCEaBb+CeCebu+lHqM/Q8N02TIesc78JIzLunWFSgzeHAXr9dVe0/SvRrcpqZjzDB4z4jPLKRJ02CypFmz3r1ZNcvcvsuM/7LoUv5BKaoOWt3JLkr9Sn/Jizo2eb2ATpa+SS/BU8V8MOT+BChczYGJBvclXseQNDWOz7eySN+sMCyRvtJVBjl9RY1FSkDUVQb506ftVp9ri1D23lwIurFhe77hOrrOTblOmiW9SUg3MqLnvnHiDvu/++Oakqa8qq616zDg/2Mi5kgh7TKQU6fase71VVH/ITeneTiLjOaAnQ0Y1//fENtu4YzvUGXgT7Lqua4Qmt9tPD7ko1WV6oPVp6iCGuPUwyuALhzp/R8TlOxQbT+4pkZyqO2NWES29uFjrf45lWn9txBOP8XHQnKr1N0Xz0d2XdkMvjsRcfHg6/ePpGbwAZdreAnmNajvCqvmsqlT3iHl3AGMOGXn5q9HD1dNc8Fb43di/1AAYrJq5UqgolqIywIsush3n/Bbw2bmicUVtGgx+6HQhE49AkIspMNJqZnHxmLRtiPmRpag3L1Wj6eQUv0RaADWobDwDShcV7Z/X4ennGHyeknCOKq0n/0428YyVRsapDk0coEU2M10lWnyR1iV4PaR2u8fnJdniM4SyCFbn3l1cucSfgRMa6rm6BCNfYTY5d7wUf1lH44dErmKzrYBQCahlYw7S1S1ez4FrdqazaHc5oeQ4C9Adq9n2UFRpIhH6DfSb3F+qrn/BzxlUk4ZBHWVuldYRtticJ9Jjam9TTvKakrHBDBCbatwXFzS5t6YHT3Tluj4V7oWHYh5+1hRzpyKFA7y3n9CW+s1J3i2f1htJOMFXfF9TlhfV0iTu4c/o1WXeWqBcTd15tMzPcqV1b5c3Tpb4nHmgIZcF+lp6ofFZhwTmMKULIol83LE4/7qbnu/JWOtRFAKK5SDTQRTGj41xtyLxUJypWpSTLbwPK5aDHaxa8wJfBxqrfeUt7OwKtM8FcWYCIPZzNjXRmWg0uu8dYo8YNzLrX2+xRNaryW2LRcX/i4+XAn/r0Kz/tyIL6nOOTOVsEwr28apuD1E+PSe5pEDnP1w9Zne9CzA3AZ3E4Kp1n8zrzb1bnhj2LxV4nwCCyvJaIT2dJuOh2XknJ9YpTVOy8Z1o82/oq//SJS3YIip7ryAqmaixIAeauEvFxDVACAV745m5FR5yLa3MHLCXyvHX4+AdslFm5tor0QrCrl43IRA1Jsmp5Af1c3mOJd4GJ8u6ZA9Lm96mzotMZEG0HpwNFfdEan86JtC/Sx0ERL3Z8ZC+EgMjLVV5/7qf1odNlnagUvigZkbtrwVIxEpHC1VYiwNFUF9jPFJ/OzSwg98I/TMzYZB5ED5QJBu1yuQ1O40C61+WIg9NPl3p42v1Wr6pqcmbCNA1JZ0XTCDDFbVa1iU1nQ7Bh1TxWxiQ+BsXOeGIVpnpz/1+14xq+Hpom7YkbTr7oosvqp5x7F9QCY34A6bRRZ8w5mKMt/jT44WpXX8bvDOzFaBMdu8Fs6UUuPqrjvvRvSK4HRm0zGq2szXzMqtw/Tu8gn4CRWo4mAde87keW+pG97kNpGhxjqkQgYrcgSkLmCL8ZtuFJvITcDv2OZ/DqRys6sg2LHnQhPyTjGU7HOOtYjGlzo3fdfZYfH7xWzNC4HjbccPLoZfggXruN9bImr3xY0rvJoov8Lt7eih9CFpx/qIczJIf/8xZnjYtZco1VuDNDWXjXJNLMAypOsTV+tNRtvkcG77S4yDemRgzm3M/Gws9WtqLj5m/TC134P66WqIgNfOWMPFWOIuYny4lLDX8T9gCwhaRqGvI2gY0WGJGp0haMFKwn2K/0uyKra5N7DfvDC5PwxcvvtnTu4+1dzFsEI+I9pp3SIACwxBNK/QRR4ulCeVrTxSm+KQijuqSP2PbwGghGhD4smiLXIxlS4hxninEJ89PZpywTZHMQT+U+BdlBuwVAEkBFjUgBqSRxEyEQMU+v5AT6aD85eLwuIeRFniFqnXQr1Z4Izkhhe9qsNIMRzySwOfKV0hhCEBqkozAiBaRsi7OiGXLuGFNKgsZwQo5zRUkBI5Yhhg78pFQ8wHBJ6vBNofj6R38a3uMvCU0iXixgnUmJ6UwwsdzmhEhMbAAxUtuZMBTzGMMRkacUknRaJEdqHSBIEk5RDJnjsCuK0QiV0MJN0IWSiFmnQrFCE0IiQhzUxMosGKkQdXISpLYCGUn6FCNKQ48UkG4OGOKYh3CWHmiyWGN1HMvjIYTuU+bAHC+9DsFkiDNfPApLtJ/cdRQLwWyGcrTkISkkqxYpIN2eX8JRj/ECAfOIDI6+j/aTUydXEKxrmJ/umt70n2A0IgWkzv34OY0NEJAkNpF3iSyhAC01Z8/Fu8YCxI6dT13cCn+dvSZ2Q3fRDmEAnShXWaZAg9biAML3itu12SXhQvpFf+4a6HYWD6GwhvnImN2YCV4S4c/4xj/oecMMdgq3MSYUIAZpEuHiclGx1lkS19vdZ0GlCRcseKZusDw/gOBE+cUEq2IJURYNi9uLU/1yc7xYwFwxion0mCChzRJOXG0ABkkayylxwQ6GyyEfEUQ8J2CtOCRppyiWbLMgkOYagvxU3gV7BCsRjwvwdbWiQXL2G8eIBEmNRVs+zi4Qp+SHkaxonFx0Cdd4RsC3+IgSsOMRAe+KIKcMgULEJC/7JAIXsdbMMBJTPCzAt30zFiOGRii3wQg1TCulpFZlMOQrBJfhhsM2sRzxdgEDyTgGYVTAp4kZytFSU/9J0jWQo3TObyd5N9EI+XbauZN3DOQovbOqSW4CAYngVdmGM/Tu6ccU+zbaTy7/JS3gJzTXRF2C3QzlaNGcP+Af3OQEUYpyjWMIqWmQFOEa5yf0zFEkaK1ojNzfrS1RPBmYIpob1pEbkdzvM0X3QbhOvBk+EbXHkOMwdBJlz2Pb6sxfNhIVEwNoGD8ciZQIJKAXoiTUGN6AJAIagGc3tlmTqBBAXo34AJVoOuE+5dePJ/v1wnFY9xrqY/xRNeuMyxozQGEQje3cS5kajeZ0i+LqXiCkhXPMwq6GgDAK3glSsCjAwuVhzuzBlSkcp+WZYoMLsyRMFtT8FFTcieU055khuJKJ4PhdszhwPT+DSD9QFFOagl/Vb/Ovao9LUThY61YV3bUIUTOQsN64V3KAnA4E1cQqIvb1U0ess4UyivaPT7CiC8ooBryS0ChGh/xJEtbzoBld6lchWNYNZlSDX718WEbTGHaH1QiUQEfmzIFE9X4u7+VSC0igElC9FcXpGCPSuBABg5REvdYWwiqMY4QCfh3Asm8G9QQyJJLV2w6XCQRpKKe4HULDBWkko/chqO8lUJxOP8KE86/RPt6fVLaXftJQGE5DNnJiI1j+gNdMF47VkquI+ANeHhwwTin4geoFc6qBjzoPFFaEH3Y0itMJ6AocMJ+S8wBjTJGBs8rj2lHZl4gTCKqJVUTs0wB7sCUSL9MO1QS1xqWuAhEdwLHPK1VxehOB8PfDaJLvehcO1hJ917uRsJ606ZFAUE2sgrFvDgfHVUggqCZWwdinFWA4uwFg2ZdztQUCGwyuIe5iHFBWUfQ4txEc/7SGA6c3ABy7foQqLmGjEB0ZP8Yr+I1tE84xL+M1wY9+P4NUP1xXqCducDQS1gtrgh64SDlQUahkHsAYoEkRCNWDVYVq+umGAZo2XKQcqIgprQee4jJbDK8xzqOWKOgIjt+YLYuLEDBQSdwUQtq6tIlLWnZYg5a3Y1nzxVutNpsqzEbQl54GDFIDVFrxvAQCwijYMwqMbZlgWYiHy2ViJA8jxTPhWbg8yqoO1KaRjJ5sGNUCcOwBg6gOGKck1pCwBwyg0ihGJ3j41IdlNGW/DlkAH/utqk/lUV8rR5POcT6uy6wo7rOdtvy1eTqZNHPIhubPf//bi29fGlsITl/ub8qiKH8lN7QxA3wTRtcECJrl37j9kdrdYX9vzzUnJ767g73TxocHjE03/j0wO2s3lumisAjHNfo/aaSIDw==" \ No newline at end of file diff --git a/docs/0.12.1/assets/search.js b/docs/0.12.1/assets/search.js new file mode 100644 index 000000000..d476933df --- /dev/null +++ b/docs/0.12.1/assets/search.js @@ -0,0 +1 @@ +window.searchData = "eJzMvWt348aVqP1XzjK/Jjmxj3LmZL6xJXY3bbWkkJQdZ9YsLAgsSbBAggZAqduz3v/+AiBIooC67BugfMhMosauegqs2rfaVfif77L0Lf/uP//rf757ibfr7/7z+x/+35++24Yb9d1/fneZpPt1uC1+/v67P323z5LyT1ES5rnK//f5n/78/V+ei01SPtH8W/nUd//fn07t/fWHi1ODQZI+PanM39rk/GSr1T99twsztS10NEtfV7OP0/vrVbCcLX6eX86C+8U1oN+1egz3SRHkKnuNIxVUz8sx3Ey/zAgQdWsoih/+enH+Gbfqbb7Ni3AbKUDn5dPx+WlEn3/7/odTl1FaNpHtoyKF/Nj609RhPqliWb4wlc23j2m2CYs43QI6L8XyWizWxBgUl+EujOLi2+o5S/dPz7t9gSaKmiaKUxMydGVDfbrLdPsYP+0zKF8p0ueLOo0w3t/9Pl7nsPe0bx5l9Hb1cL9bh4UC9rh+2J8eJ/8KaV5cPofbJ1Cn1dPR6WmBPqf5sshUuMH1XT5ylKIyPKtwfRUW4UOYQzRR9fj6/DjjN54mydUD8AcOk2T9wH3TZW/Vmge+4bK/+PA0tc+1SlShEO/2ICDzdo/dorXcsXsx3YZ4AeXTAqOvZ3Qa7TeVAHBGnx9nzTB4r/UUk+m1WkhpBNVa1VI6PC3QJ1JrNX0LaK0Wwz/2pZsAVtoNwu8nITkC2stoSITeyYd98oKYDA/l4wKzoer1k4JO+6rTJ8Wd9U2f0/xL/FWtcV2H+aYREiFYqKR0PtAM2UlMhAI1+U4Q7FnXWDm45musHF/3VVYO3m1l2kT7hM+8Vtf8macRwGeexsCfeRoFeOZpEHx9t0cZ3L3E71/7FiqPn7ZYD6MWEiBo1huWoVl1UhTV749FqH59qf6r3x7bfzUDBhs/3s/WUIS87coHPWJBfYATCDu+OvWMc8nOADJe2c+xegN2/Xp4lNsb0vhWvQr5e1XvuLdddS73nmmub4tB4D2Ui+kuzIq4WjzoZbg7SsqtwBMMLjA7kchEaF0K5E/UpRGaryeqpQqz6BkLkx+lBBmoL+bAIv1eEMrrRCKgxbT+qW9EUK+deGZfd0kYgzLgbRR1EhOh+Fj9OxLh8SAj1j/1V6k4hH4V3I8h8xsgXr3AGye8aKH3W9qi+XatvqocbcPig5ycBatBgMOPm2d58Qy0x8PT3D4r7kb5l/bt2x+g3HQp06j8kwy/f1THMiPGzW4xK1fvBFdtXcX5yzIGvfN6G7iSWZcyecx656f+gXtAp76Zu0BV8L9QuySO6pWJTBtkZ0mh7MUyelbrfaIyJEl+lJPm+DF9wCL8Votw1sLxFwGVQlQCWVuAp+tos+EgKzsfyjlOgykFZUl2eyJJKSj+TtpLBLhB3V4dzNoHygLtEEi+g3J5Yt/Bbylrr77TO75zrpXIc0omIT/IyXlh0138k/oG3tjcxS+Hpxlr8PjQUkX7LC6+UaqQmj/mTROCNUhHKujvcXqa8UYQfZZPC/RZ1aqlGT4IiEohuXq0sjHKb1+KSf3elcGfFkUYPSOclLAtwLPSqL4PIiK9V5VRmK6rXVyJfsufD9Vv+bxIv9XPdp1GYYL0R5NKRmw/DUtwkJJiKH9DLEApItV7+Utiey9FxHqvvfHX/Cp+fAT74q/5+vA4x5o8h9kar2fzWkysLvn40s80MIzjmz/jMNfg/Q73KiqZ/U7sPUyjIn5Vq7CM84FKrxYoGgFuz1XtdRZGLyqbvVZvFcFQVVwfRNVRlOX1EXFqH1CYp/JF9ln1OKds/tCCdNV82fIXtXlQWf4cI6duKbo5iYrRYBdQVSlP71070lLEG5XuIYr7/OS5ryJf/znO/xxvn1Xpu9ZlQbiRr8Ddlw/LE+SHMyZxpO7rg0E+iPxwuKR8vnuQiMdx9HxVQwNAOYnkJ5EezS5LCxWVNP+L/Zpm2/AhUZ/+iHeX6WaXHQJW2BtTtehTKRppomIvLyvdZ7VQv+9VDplJh+ez0/OSr+28sFr/fETapFWaoY3kPGr3w9/+76m1hcp31b7xqa14Ww7hMYz05o6PGdpFaYXyR9onBaazyUnE1+dJztZ5aYyKfY7q/CQi1PlKfcWN/iBWHMTYEJWDVJoYFMFZhtL9D3/9+398/7fzgb/LMEkeSk/ghFB82+m9H58gTLX2xJ5tdsW324ffyvXmGW7rScr0bp2D/TFPt50u+9riL+enKEPU1WcWh4l736rb3aQt5P1FWyOyxqokCl2MxoE/SNrDwJ0otbyO1qz7ZDhbehdm4ca35uyCXJULW/Oe/jFawPEOrC/NeRQW+gIBjYz2MqEsyBcLeU/ml3znPdELes3QZrgv+iFJoxdRmMmpSe+LBr8r1izB0SPmCQG/sxzrk9XQZdd6mPurR+l+6zPXhh4nRznIEmqPjbvKeyC41WxG6fwWp3Pn0N+jI8D9TUpLHantOt4+0bqeaA1AXkt3xBawR9U6ZYRDakQFYcofPiseyviPSNSWF8RK4k1MRTrKCuJ0k0I4IFOaho2Ux+3rTnBAR1nZeQRTPbZZhFA/dqQLowK6TOv7XlqpX0PiwShA0EHnCONje52r7X4D6K+SgXZqbqL9A5318eXtzWp+c397vyQTVTFHEW/3KSyvYG/NTDj7eXazWt7eLy5ndMRDlj7dZ/jpDWG8vr35dHd7fU0HTNLt0y5N6D+vg+7mdvFlymDbVv64HJnmxJ8vZ4F5693n2c7AA6nHyRpSANUXtmKk0XxNG/yklIXdBQTHeYxVQsU5ycrh5CpRWiIEBdSSlkMqGyrqbcO5z2WzUFUN1FopBjluYLCwKGbbKK28U22jGwVXNqKaRoC73ijApqCFOMH0BuTAqn2iJI6oWG1xQcUADVZsygEVq8AVhD9UsakHYKSC0FVJoYiq4SQrhwONmyxEqLAJDFW69cl+rbRSaxRW0wCw8BqhRgHhnE2BQqM5hJn5fV4RvIYJDalsID43IAgGCOlsSNCIDg5TfEuoMI2oHAws/rbgIMJvMNBr+2gxigZ4wBiliSBJW6seAmdnHUAXJk8fFHabnh8w6jZ2hwq6jQMkx9xuHmTIbW2MEXF7AJEBN5LQH2978DDhNpLNF217yODBNoTrPP2XmtqGUdUyAyyAL9P5TXB7c/0rmWeyCeNtkG4TyCkQR2Nmvun1dXB1e4ldni28MEkCgrNkp7MkTY4HjbHJE11uzCSKoWd8MqUzbKGkihGNklyB4WGTLCY8UrIFhodPupgAickXGCIpCWOipCdjYKDkpIwJlpecAQPjkzQWWGKyBgZKSNqYMKnJG6AiIiRxjMqImswBKiRUUseojvDJHaiuxCV5zLqSkOyB4RGSPiZCavIHBklKApkw6ckgoFrHJYWMCp2QHIKaRUKSyGwZqckiICguaWREJCSPgHC4JJIRjpBMgsGhk0omPFpyCQaISzKZ6AjJJrAmxCWdLHqQkHyyAhqTUMenscmontw4Sal+t9TkVH/gEkkqBx89WWVuVCZp5QKmJ68wxKgklguXmMzCsCKSWi5SUnLLy0lJcvUbJSe7gAsKl/Ry8ZGTX5ZGBZJgTlxiMsxP206KfW59YgmUDesLDJ4Gs3QJzH8ZRsgywjYahPV1InXKvg+fogL9NJ2nxyz47vWLr/bWBmpBKhv8SX2j4JSSLwq08IEowIrqPgmmnBoCkr/EOwpHIyeGUZRBOPHHqWVlfx5w/XSfBlc8bYHpbjw0H3gDbzhoz3NX8kv7qjZMnxPgtW19cX6gY6BBBjg2oPZvc6V9CA/085hEBreB1k6BVtA4TtZvZCdC/EwerO4RqP6HA6GG0So6+C/n7Rz4CzrHzz5F4iZEnicBYHaOpKIWYO/54TdijT1CN2B7w7Ng7E5fCPDuJ5h59AbkwH6n4fwuCgE+TMtUSS6gXuTU3HQGj5w0gXEip36XmMhJH6GrZIDKUpUKyOLEjzflGvgSFq1L7HFQ8eO2bGHTtCCIVn3cLvfFDTaqk7AgUKZeiTQHSUEURPxtwMHG3zaknueOWeN9gVGKhOhr3DBC+xrXr+BE4sCv40RAVTny8qHVtx1kW8zE1bRQHFoQRHsAqB8b1ANU8cBxEIEXb3E5kS6MSwu8mdQTYO0iXRomjzFb2++2JYrKffdHbE4i391dzy+nq/ntTfDj8vaGizcJd6fvEAS/5aALHf1NWxL299er+d10sQq+zP85u2Kjb/ZJEVeebQD9PC2ffDG7nq5E2eGftaXSt+fM7eVqtgqWq8Vs+kV07qRRoYoA/MEd1FjOC/ODpjqB3LXQEIvx9ic6yiR9ob+mw2uweybN1xPBjon2/Ch+Sb9HhFuiD0+sRNTARCwNhQIiSkLNcNhSUBAYpgTUgIUu/QRBoUo+TbMLXeoJwsLVABq4CLV/cLA8flWzLaQG1UZWtaC2YOsEQoOWIxqYUGWIIBjAJpmFBbpNBkbZ1/d8LJU3qWbmOYjnCpZcg0KBNlYtRPCtVTDOC5VlABDiisfsnMGmMGyD1TaNEVusYCR4TGkgQoaUNiCLU4Q+4WWUG9NJ4p3wMg9b2mkSPFeDBcY7UULnalCgBKdK5FwNCpLiZMmcq0FhkpwuoYMXeFC0E2YlpTljsmdEHIwU5wx4ugHlpBkPN+CdNRgawWkz8VGdNxgk1okzEZKcORgeyqkzsQ0IxtQwBGcPeuAH6/SZz/yQnD/poysOQpozaAW0OIX/2KssRlyZaBIb0yXsd4z3CPUx2wo8Dg+xyM5tiOOhp5gBjzbDbHjuCUYNPozi7zDhREIR87sQnoAmUtZEHEjnOXBZExOsAT/skxfUZoEuMMokNHSJmHadEdp25ZuniDiVOCaOgEHBp5OJCTmBrEimKfNJwetetOdHmzB6j8j5ch6eveiFNvQJdpZ4UXA5EAMRIfcBBUNmk8xwlCwSCBBUc2fhgpfcgXGqTwTTYBpJORSc4unQEPSOCciidqb5l6rcA6t9NLExlVC/Y7wu0scsopJMWHjNBAIjKSgDH11PQTFp6sqMytBaIFys8jJQknQYCA6nygxoBI0GAkMrNgMbTb/Z8KxqbnGoDMMrOk1wXFXX75qi7PSRC6k7ExpF4YHgiCrPwMhRelBUqtoz47IUHwgZr/oMpETlBwLEqj8DHkkBguAIKtDAR1WCNkSrGkRmzIxy4ypBTo7MPGwhFWi8jhX/E8pvzDsIOfpvmJIHNyxL+8EuacUqP9P9rCTdB8HDqr4+HEnzySZnHXRUvQdIxzZn3jHHykwiY105QD5aZhwn4wCpgwd6hBSDFD9CDpDaoeJH8PFRDBbkWJkdCnywDIPkP0JqBwIeIsXgoK6v4J1182BdWNY86LybRYR14s1zsMbWJe5ojW2s6MM1fhzg8RpnQ47rRjAquvf8KBeLkJVzf3gMzWwjgaplMAz8YL8FCXmuHwwG94MtYEj/FwOG8HvtcFh/FwwIrZi1oKEqZeGTvlYY60seW9PKMIig+MACBo8L4DhpFCb++kgbUCUNLIsEI21UEdJwGkk5FL+HZCEBukcYEOJkhoZrKBS6SqqkxXUR/LosntvoArL4IJjtUJvYmB4JeTvUOmYZ/8S8H4p2U0BoJG/FAEh3WoT3bd2YdBdmgH1bLyrDoQHhEvwaAyjVd4AtHbKXY1pFPGdHbi/cjUlyfWBwaA/IhEdzhECAOH/IAEdwi6BVBCwuvJMkVdzg5RpkGeA9JwvcULoP7Ufxqi8AeFavClN9YRcc17MiV184Ri7lXZnLLwj+FQiP6GEZIDk+lnCpiA+V42cNUCoCwGX5WiBkkrdlgKW7L7DlxPC4TCuL63PJleH4UIl+FwyQ4HmZEKm+FwgS630ZAEn+F7SQiclG8cGkaqwAbAMtDYonZgEcTjcSvDFeIRgI0eqRIQrBrHLj+mPUQjD7sKW8McuHuQeBI/pihkswGK6YbM2aB5TjiMnXrPlhWW6Y5O03HlS6PwO7/Ybug5nuwGG6YGK1gB5QogMGwiP4XwZAqvsFQcR6X308kvMFrKTkkVFcL6ESTz/ZMAuC4neZ8QbThQSvi1WFCgHsfnQHU9/Ue374Yntjj4iP7ojVN9lIoL4UBqZ+isxzlJZDQnxhwUyF/cACFAxWn2uBQhTngoFAH3ww48C/9wCF2aq32Tr2n8ow85TSqpGWQ/IbOgsN0MCBQeBfkuKVebiALkyKGPYdDMPzrKJg2GcwTL2SvoJhGq6xNBjxEQwIHO0bGJ6WzeTwT2CAwClfwGBy+z+AgSTHfP+CxE74/AV61qC/fgEfCfzjF6Y2kd++AC9B56cv3CDQL19YW7H4rfW3u1QeP21R7qtNbHAv1tkx5kN8pjHboEpPkId1aEAcDPlhPisf5fN8CEzEh+isiNjP0bnxDOcH8WvALjjWWULmOnCMnL4SvGjAtYCHQ50wdKwF7DlDBCLitKEVEHvmEIEHPnlohcOdPxTXIT48/FlEN2LvRKL2OOZcollwhNOJlo5JZxQto6eeVPSi4c4ruppz7KTiDYNFapRdVKZJsA2Ybg/cUEBjgMTC7Z1KuUVISNy+qRWSsGuKg0TumbpAKTumCFjMfqkVE731iFku+L1S+9Ih7pQicMH7pFZI3C4pBg2+R2qHQ+6QIvCA+6NWNMzuqKh/56RC7IzioFgLAbMrisTiqjzsjqi4P+ykQ+6GwiPqKgmF95osUqPsizK9JtuA6V6TGwroNWGxtGdZgPW/YPdPxUN9JyNyy1I4yHeiobYvEWCITUwrG3YrU9Q6OckQ25rietYJhtzihGYces+CtzvHzzU4esXvtUhlGUBQiH0XifxC5XFkm3p7jJZq6DUwftbBjEBNQPTfiGAuwoZKTUuAYYnum4WX48m5kLu3y54k4d+96YoM787ZOkVcJ9sbp0h2xE5GvAAVgYm4VdaKiL1QFoqH+cirGQ79fVcoGurTrpZZh/6qKxQO90FXMx3hW64oPPhnXB18yC+4QgGhH281k6G+2wpFAn6y1UyE+VorFAjzoVYzFfobrVA08OdZzVy4L7NCoWAfZTUTDYND1w2Yr7CCJzj8A6yWSY789ioUDH7LtZkLecG1A8vudGG/t2qRHNkFY3111TZ4Cxr8u5dOPuQnL5GQYRSpHc7wGBhPrQyBSFkN/I/E+iEv3CsDlgFxSrKyIFP9l+1nHNxdH8ThuRD3K+AWgYNZaZXgkObFSpNpY0HXJyPH1NX0P8fqDazczw+Pos873SFUeGtUjP0QEwJ0GwQE8Vo+QYBoxIQg8AmFLg8xlQBCQyQRDFjY9IEfCZM46AKhUwaAaYxJFvQmMzpN4AfCJQi6RITUABAJnhQwMiHTAX4oaCKgS4NKAfgxgMF/lwIT9vshMAF/lwQd6vtxwEF+lwUX3kNBriCnm600a/ABZxDSU5buKRPmKCeJca1eVUJlSRphISBYDqZLIjpbgHkXA4Ogrs3Ueh95T5kbME6CUoqtCB8SCshJUA4Emn0yoKDyTnAYqk45EglrlYMSJ2t/ORB4DqJLgkw7GFEuepEZOLmgPczKJ9zrv4UxrtV7O0igUgj62IwR92pxPyNSTIpsj5oU3VbMRB+n10sy0mNV9ivPdD39169UpCT8A6VaHESmrAL6e7B9odGyDLwvwRpGy886GJGQ2QcYFCILYYLCZiOG+tirjY+RnRjiA7oOTEq2QvZWPxcgKXsBvc8PmcUwX+NHyWYAL8ZEZzWMt2LSshsIRFyWw8pIyHYArxlEZD2MFwxisx8wLEQWxESFzYbAoLBZERMZKTsCw0NlSUxs+GwJBgwT4djp0HEODBGTRTHBobMpCCxMVsXKhs6uwADhWRYT2SCzDZF1sTANYAtQWRjztZrYbAxQ0WKyMkZVi87OgMEwWRoLGjpbg4Pj6jRy9gZjsNjWSh4Ml9VhXuLqRetneY6PorI9PaFRsj79XonZn/6YGVkgJxU6G2RrjZUVciOis0M4RliWyI2IzRYBCE1ZI2y9YU9mtJwRq8awP1R+xsgEhEwYgZAQ+SIDEjZdJFyDaaFCVl+CwXCmh1/O6AJzLDdSrtYoO/by42duza9AbDlK5HFRiPjlKZHVRSGSlquJkr5sh/AcHaD0ZQz6EsAnVZ3aLuKqhJRwnNcuO8ZJXk/v8EO8jldgwdsdJfyhHwD01BowCiQhg0/x+mhxB3hBoF0LcxKaJgnqBK9ZcBTb4ugaYVgsI+dPQx8idg7iYfE7cy5e4u4cGhmxQ+fBxe7S4VAxO3UuUPRuHQ4TtWPnXFLoXTscKG7nzkVK2L0joMJ38LysyF08HCx0J89FidrNw+EBd/RcdJhdPRwcZmfPRYje3cNhgnf4XIy4XT4cIGw7yEU3JBpX32C2hpCLA77Z4VwgyA0PHCQ89HIxIuMuL6LPw0UnUtwNvIvHy0upeN7IMB6wCVnCEx6qVg3CL+QZD1HDBsTnesrytW0QcLbnPEDNG2iJsj3pIWrhIOQCnvUgNXJgdqanLVs7B6Fmed6iNXUQWo4nLl9rByFme+bCNXgQZp6nLlnABaEdA1VKv3E8efHyJdCCY3r20psrEGampw/74HJbcKnCLHrGO/ptuXH9+17PFLdeG7awN98HZDnxEFTghq7rHSI2c1Fo5V/UVx7bsQl5uGrnlfnbHpuQh3tI05dNmL3w+FqtyCM+x0/PSfmf4mOskjVPgUxOjT0eGxsQ+Ga/eVCZEPD22NiAwJXkKkSFWQ7iXflcEeJjLBxypgSJMzU48DL+A1L5C8HND00NoU9JgatJq9LjVQSohGZomhpQL6DD0j4kLRqFwOVpxmRrWhgArQhBJyFcbE0TA6xrvGtuWNFEj9wCeOFyw8Gl8zY5VvX8UvstjQXW1n5rWVT5vHXoxtpv59coYGDQ71F4W4OHVfR9FJP8e4RZQrsoxtcxSNglvoeCQaeFYdzaWhIqMSwzJ4/p4Rm80lZoLnDCNRgsPWwz8TLDN2AOixvGGVNZIuEccgDUsM45AFZ4hxwAOcxzjoAX7mGHQAz73CPghH/IAdDCQCc+IxwcdD/TpdW54SEKXFLzSISLA+1m2qE54SNwe4UURhp3VujhJHgniBJWWnaByOHlYDtADo3BCjeBx7UtUtTwU/YQNz4M7ffPDkeBB7uRYakLlB6eWlqFhKmtCxwRs7dza+RoIWn3tkpCIOq/PJMafnbhWEGnHxMbavbeHSXA9GMBj21asTAHNhFYjNrGLiG3oBEES6liNICSSxf9kKR6xS4ivUgRsEBIlYm9ZUIvR/QjEn32LiPHUwdCEqoNjZTUEkM/JtoT7/LR/G8/GLaCsMtFKhv0Y5FqBbts9AJBPyC+KrBLRywFhKJB77Hy8KGusUJAQm/ns+KhrufDgkHv53PToS7oQyAiCzy7bMPMOmwpp4FqCPsAvqXPCoa7pg+jegn1pD31Sy0iheOxFQnpRjy0reAbigHQCLmXLhs142KEs+RZqmfx2RVNavCL8SzdEm7GswybeDWenwt1N56zOfLleABI1O14BEr/9XgASMz9eFBGZ/aJXiJhueVy1GyUUHkE/BLQHSM7JV4aAcemZKvEyiLgmJTsFffaMQImM5s1xDFdFDw1uyV9QBcOTc52yR7NRSw4cvZL+FAuHJmRDZPev0ZCE7Nj4gdx4dikbJncrjUclJI9Ezt8C8ckZ9Nkj93CgWnZNcEDt1hUUpBs56WHyjBoUvbNhEvPwiFASdk4Ky09KzfI8Wsb67CzlpKtEzt1DcekZe9MoIws3nCnw63mgJPVw+GKKS5+lg9jy+QM2YCoxOyfZN2VE9aRDaTXXBmlx80O9rvnZgmB9VbIbKGTk541tDUrkz10Q9OziDhqZDbRDU3OKgKYrdnF2dddEsaw28PtguPmFPtdU9KJ+siFM4kGxFNTFIsKgs1VoqIiRR3sMIC2mhkAMkyS9O1j+X8fwgh1+sdAWrf1eG5rAFzKOSUDKfmAEgiSlHgzUNJzbiBM9VVF++rpZRGyWU+N5U1jAwA/oo9bGECJByxAgOgMlYGPlpyCKSRkXsqkjCgpKRgc8qCHCY5ywgMGB/14ohMP9QFFHCA+/jEAEkMfGGCu5tjTuybEXNFO7oIgCaGZgZEaldkQLQFZ8zg+FusK8g6+tJet2+Xu9VvJ0qKv3tiN4cB0eclGm4Q5fvPW2JyZ8WomAVntdYlTEmPtXrOcMBv2Q2OiVRceMVC1NMnOBjhRSYkAFCkimnaSkgJpP6k1hv5Y/jM+gD5LjRs9d/qlhM6tAQvHzV04VtDsx6REzF1EcrjsxyPHyl1GXqDsB6VEyV1GcojsxyPFx10+enDsB6RHxl1KZljsR8XHxF1EYkDsR0NHw10yWigMUDPIOLinYihBMAALGQH3sCjhLwALHfv2wGiBrx8NH/V20YghLwCNEO/24KjBrh+PEOl26ahhrhHOEuNWz+IDXE1qrOhW75Qe2upDZsa1FihSUNtvix3R2vBI4ayTjxjL6m1yAlnAz4qJYq1gxBDW1B47frVDkoJXOCMicrUzksJWD6MzZqWfKulLjx/DCp0qMbyIAWJa8VMlcGxqjGusruLEusCTD5yY13j2gR37DnejpY2ZFQsPeFjDxsuLjYEVzqwY2VjkzI+VYei0mNmEzIidBzrzYCOlx9LDnHmwqjRqbD3MdYJWTGqsDa7DJcTclgJcauw9VOWtDZURiwNRiTG5EZYTmw9WKGyj5cTq2ELhtgwtdhe+mhEXwxsuJmTF8sAiYVxM74Akx/bmNkVifBcuOdb38jJiftlaccQ0wOYAhqi7drUrkhMYoMIdz4zMEQxQKw5k7uYMsCXi41eGswrCpUurBSqqBymklqqfli6bFqiWFi+SlqiNHqYkWqwSWrYAml33LFruzK1ylixuZtY0S5YyMyuYZQuX2fXKsmXK7Opk6aJkgVpkEBLRpMnaMnjkyS9/hlU9Y4udR65x5pc2C1U0yxQyi9YvC5Uty1YrSxQpi9Umy5UkC1ciixUgC9cdi5Ub46uMUcXFI9cU00uJRUtzuRW58oW4IvW3omW33Gpb2SJbdm3tACW1MpW0ggW0vLpZuXJZVpWsWHEspyZWrBSWUwErWPjKq3cVLHPlVbeKFrVya1n9MBRTJGiD4DESs3AWUC+LKpMdszqWWRQrUQsrUAIrV/kqUfAqWOfKLm+VqWoVKmaVrGGVKV2VrFiVKVRF1qeSylLfqRqVX4Q6SBGnVO3mcCWbopWagxRoStVlDlOOKVaFOWDxpWzN5QClljIVlvKFlSL1lOJllBLVk+JFkxK1kgOUSMpURg5QEClTBzlI+aNU1SMcjmNKB7ChuOhOoOQSUWlJKrB8j7pKoXJKySpKweJJ+ZpJyVLJASokxQojZeshhcsgh6h+lC16HKLWUbbEkVDZ+EkVtXFSefV1oGwTVk4pKOR0SA4ed/r6BgafrsGzDJSXD2GlYJDdDEItAk4dtJ4eJWfQ7Q+RLGgPzIIQA72tHgXKxwKAAL9k1n8biC+XATDq/0fAaOSkMHbHAmwF+cRBj0YXl4Iqvu1I76aRk8KA+709EqTDa4a56CsPsIurP83ybVftX8NoMDudVQIoH6gzNKPZ/nF5e0OjmPyWp1saSt2ImWd5N7ucT6+JSPlORXFIfEEOqtXsnysiUqG+gjMTbp622btSiSoU3PD1nh/c9Jl7BBq//vDoVscGArQ7YBSAdrWgQPUrGAXiFFhYwG4BGAam7i04CIXvArowLRyQ0jc9P6DaN3aHUvzGARJUv5sErPytzRDVvwcLYQCQZG4T4MGCGgEIUzf6Waowi56n2zD59ocCR0EGKa5JCA+NQbKstt4nrTZAFtM0eJt+PvwGZDSMIUdgwb1hKxnSK3bDXdgnF9hLNkux1Oa0O7mMXpil46Mwynu2DN2cE15MP8w9mVcI26T8NR5icDzsadLG+mV2M596vH4g7UZt4xAcBZB4P0yX//AlP0G0D2H+OzwDSmNdTP81v5Z5uQ9Z+EecDP52768/TRdCxPvkKcyGJr6crqbXIrxRWITJ0LSf5zcz3/YCjPY53ir4HgON9sefJEh/A1fL0Civp8uliLqtGQfWt5f/ml1+lmD9Q0XPg5JeTW/mSwnU8vk4H5j1fiXyVtf7YuC3OvsynXvyWSBStQljpvPiI735dC0zAdT2KRl6Bnyc3whN18d4O/h8/biY3YhM2McSauAZ+2l6Pb+UcQmewiSOhvYIPs0WX2RoVbYZmnUxm0nY2KdMqWGtbOm4XM0FSEu3ZR0PS3p/I+bDPu+3I/iw5au9Ld1CGeSy8bT0DAdnXsho2zgbWtfOywBB6NWWAcLQ7/XH6d1UKET4LdyFg8cIP81+/eV2cSWA+6K+vaUZeIebRHs9Xf0sMxeSsHgdei7c3C5+mX2S4d2m2Zt6Gpr4brYQUmM7lQ2uw+5uhRzcXTq4f3t3u1jdf7qX0Qy7NCv2T/uhdcPitnTEZKZDlpau2NDzYXG/FJq92T4ffPYu51/uriVmQx5vdvBjCTTWO6lkQr4bPpuwXE1vrqYiRq364zoc2Kotf5ldCb3dN7Ue+u2uPk8lAoniORw2jljdL36SeavFPnsZ+q3+8nm+mpXL7FJCI7w9x4UqV1o0gFYwb1gjd6pHLNjtdYio2NXGxquUNWAgSmUhINDa4T4JqngYgvL7XmWQL+z0UY6SYiiIM8N9GuxpYQjQc/z0nJT/KT5CD7r2uU5t4M66ovBu9psHRPWHEW97bEMerxJYhU88vl35z0XdyACAmeLzZWoovGX8B6R63AGXH1oQ1F9Rsl+rqzSiLYpGfn2Ql8ZirNamBfm1Cj2R3kdCnUWHoAAPfPdJMEe9QSBFCDrjbSBpJMVQonS/BV210Gc5icq5KVmcJOv0bUvzVVrSYkhPWbrf1euKxFSLPzbislDX5IVVi4uvrrrVJXWJ1dLS6ywLt0+KNrlPonJWDVl1yS63BNVZIgsshc7Ya/rPEUK2jnhXIoRiSk8V5S1oY9SEMUmRHnenEX95NfaCKpPYiNEr75Iq45glolkjFjqqhYHholsTGSHKhaHhol0TGiHqFb8xy05Hi4KBt6YQo2Hj/SmcqBiJi4yOnbiUKBmJi42WnbykqBkLjIue3byEKBqJi4qmnbD4qBqqP/HRtVmLEqNsFKaANmBE3bL3wdkRCXGC6PVrdjJ8tAC+gg0RnVvuYEPvdQLvb0RF6+brG/FRO9AtQ0fvRt+MFsXDEAnRvImRGtUjIHHRvRVysNWLj/atjEOtY2T0b7yCj5AFkL6Jz2GPSYcwYbfx6Q9jj2HK3sgHzRYYLoYjZg2A17jBsgcuLHQWwdKY/fqxg9hVnL9U/h8omWCRGuPaMWu/8CvHjAOmZxLcUMBEAhILkkdwcoHTCEgw8PVsdjTc1WweOONcr+5xw83zs8R4c7zTJ3Z+twYpMLd7MNh57cdBzekuD34++4GQc7mLRJnHRqj2HP5cNrpQpdcW1dcQloHwflM2B5rNTln2vE6juc9n9gNMymZikM/sfhG2KfZ4k27Vl/BwvJKJGj9uy8Y2IfCsJgkYNgUBsIjJCAXtTstl9Kwqly9DT0qL5FhT0tU9bkLaXgH713UiIn9bP6T1l/0xfcD/qCch7u/5W/qA+z31nielPOGnPI9Z7lfsgFF/QBNad6vwuJLTDPTLmUS4v1vWVyZUikmrrfW5LVB41HsTtt0mgHmwAz5A7QEGCZ4LMEMh8wAOrAvL5ALH/wYRVuz/Qfu1jEG2qctaDBX3m8ZKivndOIh439qQRR0cLnKjeo8e6TGMNQQBbrB9r8PqQ0L8RxBq/Aj2HomwEF0GQgWrNSJopl4lMA/NDAWJuTVUzh+Hw3ZvFDXIIO4XdUkPqbIBveO0N+BloBU5ChKo06Ft2tNbVN3uEh1DsXv7h2t151tgpwX8oMisAAU3LIoweq6eY/+uE72toXBn2yhdx9unKr0lgaya9uJDe4NgR8AvIfqBI8z3ECmo61pxVN83FSJuGhwcPAkLlfuCQT/uqZlhINMoTJbqdz5m1VBeNzQI6EYVIRuyaWQQQL+T5+cDenhEPP7SaRoZDFBEhVYNDak7wTsncl4yEFNLj+3JDpNLdAyHyds/3GFyvgW5jJ4XmJrZI+DDQng/MiJ+p2CCEpFeSHhCkoC4VW+zdewvOPRSlg2ppqGBZqzP9EBmKMj0UPCACV4vIibRC8O88KhLWOLXLTpoAtjTNTIR7HkH+IQwGA+aGIY06CiQaW0O5tDcgUGIawQhZemOnuFF6ZYx2yq//Z8pd1FBP1OOhCqq+IeDdWxAGAxeQGMjQ9bQONEurPMcpMOsQtzS1fZv19MP9l4PkmDNZR+zUWfNb+ar+fR6/q/5zScm3STexkUcJvEf8RZ0fsnXqpl4tljcLrioKstS0Bk2GuPd7OZK4IXu1HY96Ltc3N/cCHBm++12UM7LxXT5WQA0ysL8eVjS2+qaxNXMcZsfEDWtrkksYN9gpbF+nM6v+aCPYZyIUzq8FdRuxztWnHl6R+10DFJv5gOk22R/SqYt8GP6gPdAz0Jje6CdnmkeaGvMMh5ol4rigfqh8BOry0WcVEY0x4SizCeZ6QQpXrR3DK9dNA9Y8neT+dm8v5rK8zKArdLd2aaOZcG/nUWS+wsijgM4ANDHAiyvwV7xOd3FP6lvMNXZe36cl2TuFlumqA/UmuM/Si1VtM/i4lu1TRo/7TP4pII1MvxNOnAM6L06sLdj2yFvRAWxW00ODB+uN/FW8IefnBoc+q2n++h5/TDdF8+328R7Yw/m5R9aDsuW00PLAw9lo6orYyR/hHOLA6ODE/ZgdFzqHod+AdaH0HQ+rBFWauyyq15MyXMgx/ExTKIf+J7MCZTZ9GrmyEYRySdZPUlEB3DqwTySXxbz1RAjeSufHHck06svc9dXNYgDqfX+mONYzO6u55fTlSvbSZ9fxyMFY47o6kNwf3c1Xc2W8iNaPwT73Rq6vyE2otly/mmAybZWefw06mxbfp4urgb4XfLnMAPeaCU1ktnlfanMfh1gLM3Dg4+mFyMfGoBHxu3nx7nJoNcj5h4DbXj8sLzPgg3GLUCdiBP1u/SeHyOOpP8u/eExAywTCiqWguHAg1UTEDIuBSJhIzkjGSlogwGC4zMTGC4Uk1zrFiBcgGUFujCtdGjY1Ht++Aip3yUlGOoPlBr3eHhwIY69MXI04+NDBS5YPn+M4sPDhCNYOmDk4f+FkUEGlhMYT/g40aEDmtMfJXgZMQEBlg/g+/v4UG4+mg/i0XsJcc47iLHjp1+mWU7YyDKKjbaLZe8d6TWbR2/frikfp23RmAW5LyzN4ifYToGj/8m5FVCEaHkHNlc7SdK3y0yty7biMOGy1s1FWnMDQKtt+JCoSoiJe2goSuG5cxwoPNXvokSm972I3TuapqeDvKD1YhIZPPC0dgqMPY3jZF7+ZeHB3PoFRTqftb6p/kBlOzezPTQjCgk7G2WnQ5yJwmFhbu6zoaEv7IPi+Y8X2bGAx4owOPArycxIyAvJHFj9+4eQisosNLiqcnQLVFaW0bKvP2IqLBwWSmW5+PBKCweKuZWJrbhwaNCrjVjaAYcEvxbKDIW8DUpWbbnA0NcqOdC6tymdH0VcomQQGv7uJFOnlCuTTCMm3pTkRkJdkGRtyh6AI22OQWKMzTKOtTENkndIgWlnEEAoI2Mlw1sYDGIUqR3gNIAF7SgtiQSzeFYmhLlDQSFu0hLx0hFw9bdaqFhHYVEgyH04LLcAAQNODLItrxuqkw5Eqm6DxBj76RzVbRok72oYpupGAKFUt5UMr7pJiHw8YbQoLUG2xerbjvzqmiaKQxOScOBLctj2BQEFusaFpTERMODEMFtjuqG6qeDr6p451IlYi9QoCWFbv4icsGnAzLSwnQqTGUaA4RKcVjxCjhMBCc8rWgGRqUU3XD+7iJ/7VrmRcozM+W8fNjvTyF8DaDh4YsoKh8xNic9+Dx46Q+UG7CaptKcReSqz3PCpKku/lGyVZejEhJUXDJWzcrVmT1vhlZlZaIzkFVONWUbLS2HxFRgOC5olsnKhEkWDOBcuOnxmBvPuMJea218g+jpzHCLuInMXJuEKcwQq/M5qKyPytmpxO+piwyWboBa0+yj0WrgBbOdU1ySmK5gsvR4kMdfCYezm9O5QATy/vQl+XN46aldBhJNwd7qqMvgtT0GFrL6WzeRf7q9X87vpYhV8mf/Tc7sVAHyzT4q4pCuCTfwVfM0Vi3sxu576LhBDkWequjh/QPb2bLm9XM1WwXK1mE2/SM6aNCpUEeT1J6+FR9LJROO9MbPQGPlopjdmGS0vK833xtBYwJvJXWSYi8gRcKjUr5UPn/0VjsVdcJiLx8W9BxcYLvEK9R66j0KPhA3gPVwaJpfpaISl65Y45ojYMH4EHJPkTICaZ3oUiCEQ3AqREXh9C9IYEA4GYxR4L4M4p7CuBnZMmDvtRfJmyEXrucdeKmPmacpx891CveZX8eMjzDnrCQzvmJm7hDpl/RF6PJ/y6bi6PZD4Kk7uT9ZqRxAT81XjPhz6m8YWpO6dGvWBRcq1k2bBUW7ZcHSNuG7DMnL2vRsuOuQFHF7Ezq951CFnQejPaZMc4/d09g3/Qa2D52XVPXSI1DoWEDzl3Ii4OQeA7BZg3O+w+sMiNc5hX1fn2P1609DtZdlREb+qVZi/gC/67omMdh7a3DO27rE3YvfLiYtvqyyMXlQ2e602NVCvySw87gtzMFBeneV92F1C+lv0SHNfY5WzkUCYHBsCeUGwl0i90VnwB4fDXvh/b1gqxivNysmstN+7Hz/5e69bgMd2/pdhzglMb6afZl9mNysh2Mkm3IZPCpxGBbZtuVFluppKca9D2JdwCcTd+0H2WdXs6jlL90/Pu31BuSzE28Z4N4fAULDXiPhfkvUFfzncRfYcox0zt/Bor9THgHyXrvdhfYl4r9YsNNpLk/BpLeNuof3Q3rU/encnuKaDNtn5qT9/T3gXP/z14txjrrL6y2oK1eGkLeZ9Ba1RWSjWisihC9JI/vb9D+1dtbzI9tHhajEEiC5IA9E3z/bJy+Gck9rsWo4HiKYSflJFeBaWI6o+sEWiWR8EBUii5+osXX6VbpHTpRFcHwTlSO5O39PDwyC+xQfhUdHLLi012rxSaq9hgmU6ysdneVEutV6m+yxS7doyJJpa53UTwNoyAF1ajXef7pETW5MT4Kgcxocwx+rAs5QEQ30f4DFnhdbGpSym5gHAo+UUYRjQDCKo91+q6zo/hnGyzxRyfpTS9WWfj2dpGaZ8UTogaJY8O0gJMVQvplBbPMbbSVCApPyL+opjOIpI9a6yuxj5azRyO6l5uonzvDQip/26j+l+i0Rqmjht1T02TQjQbdM1Uqc1EgJ9757RCvUoItE7dmKIzYhdlpYWMq8+gIo1a41ofhSVoSlnVo4HOUoJMGTnr9pjLUpLVOr3yVSRfcNSHEREem9W+WXlVSn062iko5O0ANPBqUPGoUcZsf7RfqmwL1quuqz0cG+RdrURg9Ws+SnK1sqIDYdwkpHo/5CkQ/8YjZzYr1GkRZhcHgI1JEklGZ0kJVja1ZgwBmBZr7/vwzXm6FnZiEnNyn2ukGmZRkKg79dYveH6biRofZ87NuQEDZtP56cIGcFzZ6CNrlZf6K0t82jPmcA7zV3rbcAYu65lCAB/8exkXd1ezq+C5e3CsZPlATrEokGeZkjF2G3NRXh5e+e4wR5GGKU7pGsBJryv9gL5kHVOYTDO+ZXjMwU+uhj2gQIs08/z2S90KLz6cVC1FqgxrgDStWUHWLCzf85X85tPbKqJ+hoX6JysrUkz66fp4sP006xcF9fXs0sZ7KcwewifVLlIkkRFQ49gcX9zM/1wPeNzZ/ttfQX/0LQiL7mCHfjNLu+Xd7ObK9dxCihtvq83GLAxGo73l6nQunsLh1l3ehUNkhN1jAnhXUxX0w/TZaUBvtxNL6vTJ1Sw0xZAufI3uzCq8hTkd2g/JzMvp+Q/XR+/8lA2Sc8ByI7fleK8w1aOZwDC5Wy6uPwccF9hrsIseg6Ge5OVzyExIyvvY4DZ2K4oWWXhNt8dPGtXIUer3ZMIL1zpbYsHT6oIwu5WPRJnYmoJ89bOL8SHum7v4ZMx8Rv6fsQmYxKs23v7WMJOI4MA7jpb/lRG0vY/BPO4Wx7E3UoAPKqprYFwVRUtVxnVIPfePgNB7rYni90vHECTEmsI/HC9agIsGq2wAABWlwkEwOsVHHy9dmQx0yiIfceZHHRHcXGouqYgeOyWJFAAe01Jw+ZB1i5VIDCeWpBHe+tUMJDoSNUMfkC9rgFLRihxACKpLNgxVoXehiheU8AQnHYng0etCgKLam9PFFsrjsAy4usk/EB6xQSWiFA8AUBizLgBZlpTIBHkehIUTdZtRhpSL7kg4BGqL/xgrUCbY197zQhDtssz8GzoSg0I0lEPRZ2iDTxevyVR1E4pB5aPUtUBhWKFFcNFEk39RpDSvRGtCVG4TjUIFoxSGAKAOpR6sH5PvQ1ZvKr+I4g6pSNowE4rsoj+u+McZOjaEj9QUy7CWQRaE7Jw7eITNBa6DsUPpFWkYIEIu8NGoO7hte4R1hOgrWSmKzDmkTZL34TTbb1hCxx0s9FRzrw5+KjH32x4lJNwDjzHnQdYMvBFBz6mC+Cct9VOdQVGKtnqdUus3nK8GfB1BT4g3F0FntboFxXAMZG3FIAaplxRgCCG3k+AZSVv0vX6IO7X0dQJHYypWfyWNanuMsz/sS/1vsoXKt8n7tpsw/Nj2VV710izahoz06o62LBG1U1HsakOOKxJdcN1kgrVv7ptqoPsLM6luoDNdpNtMzxPmesUrWXqmqC0GD8YGYz722G0lvugU+u58bXUN652+ianlb7xtdE3MS30ja99vtkmse1DOEAiwtdvgFS9LwjBiTCfDYLQlK/9MYkjPEtbUISknI0R4IIL8zyOEPUtAJZ4GyX7tfJeQmKAaUTBVUtQmjx+VTPPaWsbTiWrgHuKAJ4k3sRQz/AEchQSIchf4h1a8x5kRPo/5P985wYNEAdBaCIYQFL+rD8prOGblFIvCrZ1BGB4wQPI9o5epI2MzFysNkQIv0Etx3sPRm/2DOL2Yr+N771+43mtLpMaHE11EPu/eedAmpjaQkH6U+rwbwh6QKnOAKjksOMW4AHJHgKotq/rK+D56G4DpIip9gJAJdAOxE4zQ0BWvkGg/AVMPspWO8KYuruBxyN5HoC99LYPgqeiuCPQvU3IbrUDTWtEGLCcIUHbX8DTnVsQRuNhDYXEUR8UNwdYRML8EdttCOD180Hg9PV75K35CWvJTLVEilowNy2RlHYnN+tyl0X6BgkbdJpaMjtIyrBkFAxRAkwsq2NQgll/Rh6cin+PHDw3+Q6YmIE2JfA0E60VHBigPJQJNxAW1u8xw5EcH+g+xTZMvv3huVmoeWYsa6R3hzREx/EwbVCHAWt++hQUy9OBwBqdPoR+9qL6f4jum+fZ/eZFuntLs7XbwHQnQUuIQnBhn/EmVd48M0Jt0rEnQjlSf5TneX7T/nH7dTL9XisBdNe+KqPL6+lyOb+kgUxqjDiiAdXtWG7K+TKdXxOZ1CaMia/IQfTT7NdfbheuG09cTGW8Ui0Ncarl/Mud84YbF1Qeb3bAS21QTKvpzdWU/KqqP6zDAd7VL5/nq9nybnpJfV9vz3HptO5C4NEPDNt0Mf1AXoRhFj4MsAaniy+zm/nUdceGm2qjtnEIq3PHcH2YLv9xT/0NH8L897387/fh/vrTdEF/WQ/75CnMBnlbi+m/5tcMsiz8I06GILucrqbXZK4oLGOVIah+dHwE2k30G+jrzziaz/Ob2ZI62aPneKuAp11RVP+aXX6mMv2h6i9/yxJdTW/mSypS+UycD8B0vyK/pfW+GOAtzW4+XdNfk9o+JUO8p4/zG8aP9xhvB/n1Pi5mN+Sf77HsfIDf79Ns8YWsMJ9UthlAX35azGZUjfmUKSWvMz9Nr+eXdIP3FCZxNIS9K1X51ZwIVSrydSxPdH/D8lqe99uBvJbyVd2Who+OVjaYlrZvELYFXVvF2RC6al46UoxXVTpSQ7ynH6d3U4bz8lu4CwfxXq6nq5/pbysJi9ch3tbN7eKX2Sc61zbN3tTTEGR3swVjIe5UNsgqvLtluDK7dBBP5u52sbr/dE+f89UuwP5pP8SsX9yWrgP9Z8zS0nkY4ndc3C8Zsyvb54PMruUdJ6DId8NEFMtfZlcMqje1HoJq9XlKdWuK51Deq1ndL36iv6Vin70Mohtmi4/z2TU1K1qq0cdYJUJZUdI+9rFVwhY2ZpsL1Tt6xwtSpNTd+8IRkbbBwJvA5U/6GD/ts+M90N7dOU1g5O1hU9+0vWJ92DIbx0Y64i6yjY+xpWzEI+4v2/BIm81GMOw6BBGhtqHNk42yGEFstTamg53E2VT9bXOzjnDsbGsC422o693Sd9dtbwa71W7jOVlhMpTYJrwXkbIj72qUtT3vp0Xv1eNZwRv3flrCLj6eF7ql78fF7+8TaMGb/QBews4/nhhTBuBnptUE4KmhBQJ+Yny1AIUWWjoA4cXXEeCJoUUFfl58hQGBFl5uAACm1B4QmOGFCABmSlUCnhlcogCwy/h6BQIvpHgBwIqrZCBwQssaAKz4GgcCL6zgAUCLrX7As0JLIfyw+LoIAi2sSAIAi62YIHi90PIJgN+Lr6XA84ILK/y8hCoLAi+w5AKAi66/wNNCizH8tPjKDAItrEwDAIut2SCwggs4ALiEag48MbC0w4+LrvMgsMKLPgC8lAoQPDOmHMQPTasNIVDDCkUAwNiqEQIrtIQEQIuvJ8HzwotL/MCUShM8MbjsxA9MqEHB8yIKUvzEpOoUPDO4VMVPTKhbIfACi1gAuOiKFgotvLwFQkypdcFTwwtf/MyUKhgCMbQkBgCMr48h5IChxTKAFDC+cobACy2jAfDia2rwvLACGz8sttqGQAotvQHA4utwSPYCWJQDMhjoCh0gMadcR++CXrujtSNQyOPi4lUTyJf4OFn5JQZ+4E6xAYOWWXfgr1PaxT+pb5BLlNoPjlWXZOgTWY+kDY9Zh2SiwdYfWXgodUcmHF2WjKNN5vQFjZHCMk6Q3n1Xzpq6h942Bul/VzbSFBHgIFqCZJILzzo1Feu0HxzryiStT4LNQk5DPAVlRorcI+hiokxTwHdauxOWQEaeu357c7rL1rmgTk+NZWm6HSLNzHlUTBvT48AaGBMJxbr0QLCmxQTSvXm4KP951f5qJJSkEgR/MdJL0ny4CvOrQD915e87flI5bjFMTjIC/dc3YKv1tdo+Fc84jEY0OYpK0fg+DGEGgd7u7GV4TJPEd1djD+EsJECQEH4MyV8hU6+7FPkCTjIC/efF/gGprQ8StL4vXNbJ5GKdnhrLvzp3SHCuoIo4gHy/10Yy6TSCwAJcAt/Wz1gwvKoGAOlKG41E0N+QC7drdRx0tAcWrteMPCTgNn83HlrXA1I2Ha2P5SIZAMCV+Lwfc5gfsWMfsFAUUwFJEraMBhYJbz+8kc6HffLi+6zU8ZmRopxOd7gY5zQeXoTTZUDGNwYKQnTThUDGNgYI3TzgfvYJ9KMfvn636m22jt1feOv2XcqoRobS/4V9vhs8p+MzI/lNp+7wXhPqJ0b1jv61/aqv/A0Dpf3wOKK2PBOrowA/qaL+mEMpsPclfUzPj6gYLV3jlWRvzHyFaWMjKE8HHVGR2uAIStUB1/2uVr6MtxH5xVUN5E0DomSxc6PAhRSDsq0YltLPosIcRLk0FzBdYDEU3edHNBq9rmkGBDOdg1ybz2S2idYYCRPwPTHf7gIElD7hQRGKACFjFUCto3/jXXtwXHvI2HjXhydiAVkb7zYeus1jbbzbcJyfZoeyID7EbuPoaW7/xrP24Li6mrzxTPoZ8CjkXwSnRRBOti7wHlpFws3uDFtQy8g42lY+rtaRcbWteHrGNssYZEdpWSZ3SZITCFYI4qOx6EeEa6sLvIe+5Du3lAlEB2POJb/T6K0wAlEyJhhO3c8LtQEvg+rh91DzrX4ZKr4eqqB6b1NxVHuHi6vW21gcld7BQuemze8JkbYEkYBSJX0OVNhopLAob209+RR39fB7KO26X6bCBk8PGg99psglHuxwxOnjVc2X4S6M4uLb6jlL90/Pu30x3z6m2cZ78adTcCSVDWHAqW/36+CpchAtUq1DeQkqHoSLVPdQXL3OZ59lnvAQxnpqZxjOIsyeFB/z1IwY5QVytRuMiFNwJIPiZsAbF5HJyEcVm5d+M9SZoQLsQpOVZ6YumQqikf93MFo6iqDtOr6jAU1Yh13SkvXppQ1aB17SrvXh9UV5kpGC11qUZgcak+6axNqURv7fwbQcUYQtDH5aiLEPMEN4GnzFc50O4v8O+lsjEVTfzQsaUHvr5JLKu8curbt1dEnV3UOX1tw6uuCy7JED9XZnJWLV9kH830FrNyTCShs9IaTI5eeGX2M/h9snt0KpnxhL77Y7Q6rWw0iY2lPrH6sguwQUHagBYNVcFwBTcqf3DCwv6vV4YZtZJiVTPzGWHjl0RlAV4JeK6Bj3foGrGHBTivbgqGuac1OKPjyJFc67KcXGQ17vvJtSbDj6Ya0wL5bqdzRLJZfXcjIcO7X1HaI2cpzlZDgABWxGDkS5lI2jqyMBN6doD46qMek3p4CnZZC35iWeZdJqAwcFuLCkM1sJdNSJCykkhhT/OeGosxlnkXzVIL2H38MykatB+kMVtFCMahAXF9dSMapBXFj6LszhQRrTSVaOZ60SVShnYYjjpzvKCvKkEY0lBX2xCczhrpWxYsCKHcAUOcK30Zc63m5Ya3bsWs9n00es2en3y7TtmEVMQ2KtZ8CVGZ2VTYTkLHIAZGu5UwGJK1+g9snLRlQHgLsXcM6liY2qI/xe0uFimlbablkad7fJM4uM5TE5e0f6TZbBM70nNyHWh/IyUjwpNyLWn/Ii6uc5oyJ+5bzBUwPSZOpruTi3YcJgazUhTfcYJ5y31ogLUF2AtYfJ5zCLjOV5WHon+B+sSc+h489/wEVU3ZXAAhZYFJBbxROh98tcKQCbm+XQ8mf90dFsrKlXrG3VB8m1qUYitC21MZFsqBEJbTttSLr6qK5Pu8zUumygHK/HPzOC1U1EWhNSdGobPiSqepjAdRCODsJSRGkWP8VbCs5ZksFy4V3rRsuoPTqaRdR7pVhC+BQOIsMcpoBNTM1hUSEXMlaTM4jaU5uEqzckD9qd8CRI+tz327xD/R7+/I9Dbixr6EdAmkbXu2DaSQAr1mjCaCkWFACLNacwWEp9HQAWWTwFY73ArSGTYXHIjWVlXAgEkyPzM7NZBX9xlgZdsafw+Y//Blq1ByOnX1tvajhN2+cX1LnGEQhr3/4ABPWwcQDaUv29uitMjv3Y3MDUmQrd+5Ao6Ka1gZnfsrgQnObH5uSpYVbQoAeR9vD8x38Dy9iCkbWR2CUoiC69GiFFSqF3b5A0Etkl6h+IvlglRyK8br2+zFVYhA9hroBBoOHxkbwUe884l8Q0YJ7/4SBDOhtuNoJn4UBDuhFuNL3MI9nn5YKgcp2kRZnSzSYuCrW+363DQnmKn52vrWloXzcErAbAke7CqFjst1tPabSbsmokOzUyAKFas97ioQn597d+uKn+C3G9PmwPwqJEcf7ysX7oZ5XlZAU7qdo5/PH11I4oZxpdpnv3tQouvDSKGnFhqiuVMMHWKhmCTW2f4i11rp2EJYni+kvfkVoWYVasYvJCOLaTV+0UsfiaKMWLuHpArefbtfrqrnNygLYaik8NiZJm6Y4M18hK8uS+ojCXo9TISvLsmQZ1KDu637trkV1Ie1gBopvmAuRjG4Jiw+MjRcCmnvHhLsNVpGIxvUZ/wHdy+4LDfAUcU4JQm1sdbAiVzxVkHc+SQ99pcFDw8i1JvXStuWGg1w/Btu2HknHPDQ0EWnqVweH54LXjn9KhjY0ONIA0CiLNPaRjt5oaDrZ0RiWB280NA91xc8m0LI8XcO6g8VmD2mkNilhi+ZkbHWYALV82iDteMXkA5kYHGoDmK9ORGW4z4AyI5kCTITm+tB9S0ssYwbfQnG06KN3vpuS5L0l5ykbq/bLeOgA7+X18C+I58A4nPxXeJ5XJiHdA+YnxPqj+FUweH9WT8lBh4/cOFVW3eKiYv+VAv+Abj+pNjMqZY+jqN1iqoZF6v4zDEUAk8QBeikw87qr0m1iCI2BBZS5VwDa/GCpz/QI28sVQmYua4sDcEVLTtcz7OS/t7tmuy2H84o6Lxsh3W7qUMk6LBsl3WbqQtriUQ6k3I0HpNH/66oAZv1rm/UzfoXsRw4f+QVmQUr+tXws+zF6VZyf48MhYOk7rDanSmsEwNZhOgFVYPQaKftIRsOqoh4At6Oi8AXgRh7tnzzVCvZ8e5li5+yy+7TBjbR4n9HphXVMmVXl4hLCitBsKqlRq4dbJTUenh+E6sDfC80patV+q2u43nj6r57Edn8XbP+3ZLFwuZtPV7IqEMYkyFQJvEzI3Y2a6ml3PyEyIG44wTPd3V/T3dEh1yjCRbHrTKMGE+5QgaDvR2D1qC7HbAv0mJQsMTk0CPnHUXtsoEqTuBPgmh+JSd0h2fGg0/0TvD+uhHIfE9VE6FGgvpc9B8lM6GGhPpY+BvVi5x5DAL1X29g+4yLjXP+LaV1P/F475bzTwzUNjRVmn/ig6GfBzQ/boLAyTBHFZsaER6CxAUlEmBEA51pcU+G+l1x4cTUn2+8QqyvbwuMrSQINWmGYektI04KAVpxnH8f11KAn4Y+sghrh8Ao3QCMkQvCjneVsjwEGG3P+FZ5Ua1XjrwdFUebtPijpHT0I8CHE+QqqbWjOTwEWapH6s9nQlUFFmrt/WqDx+2l6l0X7jyxVqT45lbUydIs2NPkKmvTHyYA2OjYhicYxAWJNjA9KmbxAWRRg9V4+4vWYjUkdaiqkc6WMSRySitqwUD+CyewsNJkeEYmG9I1MbUnyeQydmIGDZG4wgSaMwCXy5azNIW1aKx/OpMQsJ8JtYcIa4KkKnzJa2rCBPHnh9TSvPSVaIJ9wX6SF1iufRZIV4HuOk9CQIP9ZZUIikW4YNJsGUWoNIknD7tA/dn2c0o7QkhVjSXUFbTGdBIZLX0kGp5l753D1xAh+bWJd/F57Hr7F6I7yloxid4sLnC5tCOu3JsWI6vVNCUEd38whETI/PH04Z/BoSJsO1AUDCvpHiQST7hnBAqbcp4DACoP1HKNyUFC8SgNX3J0l0DNcSAOn/9KoHj+RvwsA6nicVj+qEwiA77igVkuqZ+iENPioFkuOugr58oDmuFEKyDwvJIYIOFTrxyI6tH6/n4lL46N4u4Grvjt9L4SO7wH68oycbVMeCBdaKuT15bM1LJoHSHGZkItl0fYfXp+9fLzJuetl0Cww9r2u+0oOfdDZQsvLPZk52KtqAycpKA25I0aq+KIDgyi8sWbXo5pUxYOFVrcRNKyKMttAXevmOTehdAmLmRTysycbj4887mOEIYm0KMqG1FqXRrYblFptOawTexaDofXOMyXHYkoakQ8cyIn0+tgHp4LGMRx+PdGjLxYc91ePhs6nm7vz3quVG4F1U8rFvrjom/Hx0PJFfEqnVfsb7ByeRd9Fs3d45uu08eEnt1iNk6TcTI1vD9RBZOs6E2LkbLknCsunmZl2EDTWAHpp6PTclTwu+29nHir7fGUeK323sMdITMV666uGw2Gesxd1qQ57Pd0erjw16txSO65DDyfjzr2louPnX3Ap7p7ZrCdJ8d2pImvQtLO3q9ukyiRWqhqxH2jQUnRoairS+dFQA9NiOAKfNM+z7EF7f8CTyLt7huXeufwg2fcFr1/ZxQCemZqno4pfSQoeAv5iWOgDSnoWVXMBmQi5A7FpPFrOEIRW6tREKzLOu0NsbM9lZ3W906AHkwa5jfwUG0G50uAE0NiqIOmaZNYB+oyMMQLfWMvxcy03IBORfwt1CrfcR0mc/y71bTqCHwE0MtN6FdHagz8pOERhpRfIEfVh2ssAIqy2sTbjjUh6aGIQuk1gik1MrUowu/9ywskFO+lnu3Tz1FoKEu46bfGxIiXkIOUyu/bR8apnJ6TdBaZQfzgsuUvd9re0HxzIyhj6RVkUbHtOMmGiwdsPCQzEUJhysZbDg6MFnuM/V+oP7vLURphZ8gB1dhZD4j76bMOBHjSEMmQpzT2WTCeIkJkXxSEB4FOt/nUb4pVLLyPTvOT9o6h5Y9w3p3Xf5gKl76BFuSP+vYbLHq6qjFJnhwmM1TP5M+8GxHBitT4LHAleKwYP3WL8DZtJuBIcF+BoN5IYGFxxNbUI8JU2BEsiIuhSC9sjjwitY0LeQOFAUrQsokfeWW7iYCKpY5IoNFxNFP4NqzffeqMCFRVPaOLf/Z5Q5qZ9+jwCg3TEjCjiMVjAU0Lg48UCXjBsUaGCcyKALpusnwLUXjtcFP90IJvJdpWClgZ5uc5FYnCR9jfk8pfrp93CXDh0zfSbUdCFC8WYOxBXwnpT0IpKnE0R918kezzSvnxlPVbe7Qyvow3jYalljwCvjLgVNBWsQeMXbhaBdxdTBQB/J93HArhbqUuDOhvsYYLZHJ8ApDlD/xHdBOy/vY/KmRnQIsC/u7hV2nVK3c9xpdx+D3+7rvcP1s7dfwLVJht4RZ9UBDICrkgwMiKPofYYLu0Uyuzj1M+M5NofuSO4MXgmjKMj6WPJyFBsaSSHJXYhiwyJo7iEuQfHgDfb2IDkXMxlOx0tedmIjIil+mQtObEhIayB5qYkDCW8iJC8ycYDh7QY4qgHcfq49OXKEw7n/XB+hTLTDuwHdRsSIfHh3oNuAcPt/BhCcFnT3D3Q1dQCkhnETpC94gFpGqH9gVYBpQuDKAgAskLoAAwhmhws0JwCVAcZpgdjOAnH4agOMENC9KzNBPxIA3I6vPTlyVEC/Hx+roAgcJF0llNR0UJEUGOC+qBcWFUWrAY7cwDf4HWzYHX4UInCL34FH1IBym/zOyUZTi0Lb/E4ygq5EeL8Hp39ZhMUelFLSJUb3hg2dU71ibeRS3rGJj+wlWwhZ3rIJkOw1WwBp3quJDG0EIEQ5b7JPTvJ8LpMnY1yRTo+mLUFYj2cI2Pdgzf0SPg/rezvnddh5G/0PkPqYcC/H2157ap3dwunP0/n19MP1TAZ0Er6GcRI+JAy10WvZTP5lvlzObz4JcW/iPIeeJuRQ+7+Vi6EmZHzh1LzoQeuFE0VgFTYDjKe7AaePdZXAIeUqdLC7tXwOs/UcuHF2enhkJ6vbL82/Og9VxrXqURG9KhMXw6HqYRF9KROWfg9kuvbcX2MjOkrKsZSz3XMNkY3lKMli6TtN/XXl8FtOD4+cBDr3S9fgyGlCA2LMGEA8rM0dIiB9GnlV9eyrivZFo9qdC05/ciQlbewUp6E7I+SpZzMPUjdbiQiK2QyE1MpWID0ldnxqFW/UF/xcmZwaKMoGNqAVByPL6ixQvlDFPvNcNmomaxrIzg0IkRVpESblqsxnX8NNTGKrm1iXTahzE5J0P6lvXLqXsomB6P6xT7P9RuAN/l43JPYeL3wa1GCR9SdHMsedTvG2GKkcgmpxBxufUXZiTUytIUEhqep60QdZV21QiA2NiQPX87j6EkYeqO5ioDCb2xsIu9IRktjd9gbCPqgN8ZduaVZkEJp3t0vCeOsv+tEeHM236/eJde3aw+N6dgYatGNn5iH5dQYctFtnxulcf/haDtF9wakF5iQoQ7J+qP8L+jc6islQPMYqWXucWwPFSUyGIvbdWm6EOEoJMlyG23X9BSb8K6nlo7a8DFcSey6PNdIcpWQYNlmYPeFfyUlMhiLd+UJ2A0MjJEOwg33iwQiyw30QAMSTq0SRVGtLUJbkc+w5TObEeY6BRxhgTC+x8+Y5M8pBiExw4fFGjIFS68HR4qR2n5QwiWJs8Sx0uwu4DkO3wAQ4ojGGfNZSM8sENKKFBn7SkkNGM9tAsCDqW3AqY8Cw5oB7rGP/NbNORpqJ94N1jD2BjGj3AeWdO++ZKicYyRnwY5ncAgIdx0MA7Kh3fQUCIdltgOMFz7H/JCQIMqB5EwDUtl9BAaS4GLjkx5dsinHYD4+/RyJE65mRDmkGLJgU0ck4qZEeGzdBoqNx0iQ9tI7/BriLwE0GP76K4FrHWbnCPV8Fdv2YLXlJLrVd/+S+z9EBVQoDLw5DEMXbKNmvVbWhRMRqWlgfWpBkO5k7IllbXpLLfyO4Awp+1zKCKC+aMlGSTi2gNaY4oqygz/VaXH62d77AjmOCf24dQVR93nb1bUdlqsSLgziTypKW6PgJvuTE4fHhi9BNneIr0N1vpFW/2TMnvVJjN9CpAQ6ar/z84y+OUmgM3+TxDR9f2Ns00y5mPwvRAguN8bTnCfBzd5UiiY/yQ/78X6Z3InjQbxjAmrT9+Ff3l45jEhhclkF1E7Pzpk0nzOwp1gengrHdcUBGtadJybBcHx1w5nW7Dvw3/QJQzw0NA9q44MG67cWTaTutDYPc9+3JvFw3X+iDKwBSnqqCHIlpRwFkTFZAAMLMCpmF1W5qGNhOxEAmZQUPgLu/S+MVFG0PhUzabkoO1paHvMVs2VcPv0cOstUvIwNZD1Uw/9im4mQfO1zc3GMbi5N57GBp0/0hTV82Yea8lsgK1RKWI8JnQjvvieh4uZiUuRIbA3ZqIm+akKNDFpa1qYhb1y4aXBFVG4a2y+piwec92zx0d8jFRFv/sqseVa6j6WzKfpqTpB0HokgOgoIkuMyvxkJz8zw0dBhhFmSutw1DdNacNLmao2pYNZ5c0WpiOkSWHK/mg/mSrdXD71GCVvfLTKSgXAoaE8+7AFwVRsn2mDh5LgcgeXI6spRr3gcRt9/cEND4qjoTK8M9GaAqzERI91kGyuyYIHmODCCrwwWkeTfy5UMmNrLLA8Dja266HzREFswISHeOQIgihIMB4rNeJkKGGwVAzFWArjQ2UrYakgJtZbs+ln85PO5y/c5PjZTf6nWIS2y1RsXLaPU5kKksIwkhh9UHQSavjCDorFUfA+NQ+hnWnkIvw+8B3Aby9w3PR/Up8IkoP89bmG09Jz37IGchGsGFSzMYgq/zUyNFXa0O8eEWYREgKYjrAbA17d88tUPhF4l0BGVnI4ROGMzuKsLikRaU1+zWyZbpNky+5bFT1WgPjmR8TX3i7K8+PJ4JNtIgrbCNh2CIjThIW2zDQZ/0t8DATxyCSMq5/EIBOcsJcdTXoKOXy+QsJ8Oxz31JbSPGSYxMceHRHwb7rD04konW+8RbadrywLPQVwroIsEXJh11+UA/SeAz2W444pqCRM6ABImTjbjQcEZ79jVK9tUluwvvt25ccu9h0s0IDAvffReCBt/CyrH/dlquO2CB5XgHdlj9YlXPVTwQTOhVAEA+i7GyrRuf7erIDX+Gw9k7/jAH8K2dV8tN+yftlaAD6apGRBC9Hxe4vvs8/TBbzS+n19e/Bpe3X2bLYPpxNVvIjWESJrvn8EEVcRQmybcgSjcqD8LH0kDIDa/uzjzG2Ze71a/BcnY9u1zdSo5LbXbFtwBzOJ0/ln9eXt9fza6CD78G90vRX0l9PZy4DB6+Bft8pN/m43x2fRV8mS+/TFeXnwVHU++WBps434RF9DzKWObL4G66WM2n14LjiPOg3rEMBVWBYwzXs+UyuP15trh2nftBj6LU0XlQee0J7BQQexw3s9nVMljN/rkqF/50ITq1tkqt86BQX4ty7YfZSLNreXl7NxtipeRRulPjrpTl7WIV3C6uZotBBlSGAkGarVU27qhWt7fBl+nNr0Gt1JaCIyrSNNiE228BvAaEPZr7m4/Tn28XpalZ/XrnOFSHHsx++xi+pllpaKDHAWhjYadAuj0xMyKUkIBNKRIdwCLs0x2W3oDm9OSYUXS3U0LcfB6hQKTc46HExiYiajTcA6LEvyYgbXqH0M2THk5LUogl9pXOmkGOYnSKC9/KscW1pyfHTAmfOyVqQPykINAw5ofM5YNuOuKkganeK/UYb71nOzqPjql8e70StG9rkALqt09E0b9GJqoC7iNRNLARSS9JUI/hPilqY/+HonA1LYTnFoTZPlZ+Lh3ssRGXovIfKrPwIP11P0mtRqZZFn67Vtun4pkCVbcRVm0kpzak+Jpcxcc4KVXkEnBNtIWxaeexbgedYTNyXnh1ps3qnh8d0+y2eiXaXfByC8KuLqBwTQytYUEBBVVNJ4+aimDxUtWF0MkPDyVZh0CvLq5VQZB09AmJ1dygPHijHoKDfgiAd8x64O2Nygyg67XBjFz91Ji+WrtDgpt2GJWAh6ZxUJyzLgnVL9NAKC5ZFwS/BawhoFI6zr4LzxWB/b5RKbtu3xeu+W8zvvVTI20bH/oibhJ3R3ue9e473ow9o651M7VgTup+uL29nk1vqDBVlXSiQtDROWtLlg2b+y8fvNuZdrDy8QeEwwHnWq4Wzk/Ye7hKXYGpBfNwkX3JQ7tENxKuvpAEBE0G+KCc/7oiOxBevcFMffWR4GwTgjI0rWfHNPv9bgnGvz1OARfAwERxBMxUVHfAAEVxCsxQeqizTiPSOzrIyXGoR9pP9ShJAXKUDBgoJQPg2ME+xmXD2eG+tgGlArlyBhyUxjNzXPh1nc3haj07kovX7pHo6JnfAsrdM1PgnT5jO2ZH5sflrc/v81BNfsthtyZ4GrM4WnezS3/plA8x36kIUyuFpawqipiIVeGQLB/ZLWy3TnQOsWaMREO2aKB0IpeNZub8aFDX2sFGtX2S357yMTINolxE4GCkWklYdOC/yKH12JgxAeMqh/bABCIB1mUOZhaq/8+6zsGMoifl/W6ljhDD1427Z5CHrfeNUjDu3jPCKpichIgEF86VaHMiyTcnUDzWpjOis9ob8Xn9dQZr9mZ6vePGbm7E7FtdLmbT1czxtREv0CTKVFgg7IilMdvZi/ly5SvrdeKpr3EOuyoBSEf2/MhXceAUGJYAr8vk3CgzEEHBQQ7yaisPDUXSejBfZFVGJ7c7lYWlQbvCFOPYBMf0VzwMBA/G+joEfBofLcXLAfBS/R4fLsUTAuD2C0UhNWs+WHSJCpZUbavD7OxlMzm3I8Z5gVzxNsfEJjhmkZSVgWjZ2BOSzyo3NyHfItJnqQC91ISFmSuVY7bWtKfHNEymjgnWSB+tgAkyclHsjo2MamyMYBQLYwPTM0RpESaL9M1fTWvkqsWzg7ggVXx4ksZ0FuYRXUDWm81CaE+PaRb0jom2AD51gqw9d4hcE60pAiKw3lPxSVmTy6vYv6iqlid/jndA3W4UGEm9u/rGaXjzsHlK3kmH1PM+PoKqd+Ihtb0PT3fbkuQmXbt1qxOubGDbNCBLVh28LRclj65pRIzwArg2DXbAKDCSKTD3jbcG2KkVbLVfjw43aTdGwwR8++MwWeSguw1KgrfMxK3zxuvbl5EMwKkjnLYv6Xmq/dwvUo9rPROU9rljpIbWOtamYAr7KScp6HpmrZ8L03wx6Knbl5GUUtkRXgOBXh2wP/Bb9K7Au+POPdBPMz0/0ip1dI1bt8Yx81ayiw25tj10hNXugkOufw+cXpbzcOPZjHa+tQfotg2KKY0u0/3WuUXtpEqjqJGX5rpSCRdtrZJB6HaQz0662HaYDzaRyNR67k+1gBDVGhEaY1jzUgGQ8Y7CXKILmOY3WFfT8yPZW2PXeAuMU14BYNMZADY5t0QCBH2eIog0zcGAbbU1IG6pqESR2+0NhN3XgXRktjpE1XYGsJQhClxrdaAh6PqSDs1SnSQHmmiKGrF3dKd1Ar5XfXwR8s51h1TAx+6zCrnaHVQBj7uP2vk+A8GN7FEytKmHD7ApBiBk6h8Po/er7wBC8LdUYXxu162rc4AeXCP2jo7ckUDGn0MtDS6kyCqR2vJDYMssHZkvEiOwJdYTx57zzPq/jXUfyMgPbusHM/lDW/7BHACPsjvdbC4yS6C3pNN5X2P1JkPbtCTLCrK/PDP8b2ONBzHKuOkqxCw6c/0mT5vDUkOQm84k87ekJC5roXc0du3++Tbu8ArkTZtGKWDRupxChkzDFLBfXUy9+iIq4lfemzw1IU+nvlZVOfX1BHS+ViMihG7TpK9foEWqhd7REB36l7E/mOnGI5SYeZDvP3fmIBNaZDrCTctpr+5KFWGcVP8TV3vgamBskwNgIZof52sSMkUQeqpZAvJzTBQEn2qugPjUiAs2b9CuK4UaHHdBmNG+KpDYYOJAesRl7lwNjG36nCwMMygwjeXIpWe0bDyGGYjoNCeYTrLJ/HcwlfImckjTOIRJHNAUDmECAToDvunoJsVuqGAYuxspVErK/gmGE7756KLEb5d4GF0mmGx6/x1MrrSpRS8XPqjQyhHfjISgSy0n4Q1JCLrMGvPa/4XaJXFUP3tZX4+0CrMnVZSNlv9efV3HpSy8wiP5AVAOnC/gfzU8fwBMjfQJMNwEvwCMjfQNMNj6FU4itKCKSTLj7rxIRWj19obj/l2E9ndpxguC/jL4DF7hkfwGPwfedxBYTjKwQitL8tJZ9BCkl5t/ML9LD0FmDWL8iauwCB/CHGoDj4+P7zN0eiZ7CacBi/kFXTK6J2Bg49n+Lhrd2hvQ9G20feFMfDugGlFJmmcVruFucRfoLC3JVJHQeA6STBajNe6tfrf9PT4+vsU99cyysahJTGXizGe/yenObDIlb5L7QdvTnQxJn/kUGzjF67BK5P1sYat3tj2sBy9uE9uEfLvYYZSxjW1Evn3sIGpLovz32Pk1KA/dUV6aKw43DKqDtACT00JpaxNmpSqR97NUde8i1go+pThw7NkFyB235hkLlTflqKbhA3H51nLvayTaCCKW4vAuBjEXGquMzejSyhkODVbGenRhO+mTPH9LM2h+0oraamcQzn1eVRS6r3+BcLbakeL0mhl9ncNtTS33vgbngCBmdXBTkU0qNisB0Ul3fvLhpaYq1TzNSV5cKfW+pukMIGKYqrcwiFlqccoYJZ1UziS1QGUMkg6qJ0x28U/qGw+ybOOlbkOGz6ve2+sErtxLqfdV7RWAmGJ3/6TBS+s3ZUJOzu0xYFE6MY32G+UuRjM8/g5aUO+Zrv6OA5bTex0yhsLrszE1XQeNoeL6aNpCCMKiCKPn6hHwRkIHrtOEKF058MfyYTpbuwFRsrVKVAEuoehxncWHoOK/N1NDoqTur0e60GCfXsOwJGkUJkGuoCUmPaR2A6JkmXqlMh1EpWnivHyQPKvaDUiT5UG8fUwZZKcGJMmicBsp8JZoV+0fhUWJnlX0sktLj2deOT2v7lO+LrpTQ/G5IVHSdLtVUfXkKt6odE90dibndopTO8Kc5SvYp3vqutAaECVrVc5Q2eomimMTQ9HVdT3k99di3B0bkiRdp9F8TaUrheO1NNFjnBTuzws6iE7CkkTPRbG7PK006suqWom0ViQZ07ct+aUdZSV5ft+r7Btr6tctDDLnM1VkscrvVLZQZS85VYE07exUlp3akeTMS0+VEVq1xEWp4tJ0L8keZS0u70/mafSiitsdZ4Ue2kh3Q6zPPN1nETmzcBSWJ7rL0q/gBKARa9e0IMlWcOz6IBb90CjnbTVGfIC3tc/Vh33y8on8xsoGHsoG5N9a2fDlyZemLsuykUhrRJgwuyy+0tGyqJaWZHqLt9t4+7QoA7fbbUKdb00rVfiXHloRZUyzF5V9CIvoeUlPTB5aeahayUWSkwbGcs2WBid3nxv2Mu5arTAZzTsc3ay3Z2ujefwd9jSOPfM2MyjJWyqbRB7XvyVtyEzSgbnJSQBuN81Lh+VlfOGoom9YKg0MwI8lXjI5NwwA7GeJ6ZzchDEAt506poPSs8gwxE4+mQXKSi3DcDtJZhYuK98M+Fymnnkmo7KS0ADMk9MaxN18NJ3Z2OhAAzhlq4Kik6am85vaHAy/m7zmYPPy2ADcOtUbdEJfOnGnuRGgg52e75NhP7c6zBCqD1DFawHqc0PDgHYS42ROVo4ccMKtKHZBZEiXk4ENLQ6DrifRybycfDrg0HqVFxdbap3WhkFuEuXBTmVB1km5k8nNjQ4zgF4mnkzNTMpDPrtWOjUyvny7qYFg64x7kO6ENEWvvaGwtWQ+A5eR14diBjstac2EDTgJbD+ylPczsNtz9Exk3myntWGQ97kKqiR/IPJ+O60NhxwZtg9Y1PytBNjplCBq7SpwiI8tDYPa7BIcova0vdtAZjY1ORB8nZoP6v2DIG9vQ9DhDU0OCr/rbU9w2blbFYBifVCxZPPQaIX5en/YcvzjkLhF+B0KdOl9n4NUcN/BQJfZ9zH0o+C+mrFO/+C42NNvXtpKzy53dxo0EqS+Lxxz3rhB1zw02rbcsT/KZhziJ8Z1j/61Aa6s9rsjcfBTAKIC86v48dEzFetnxlOA7e7Q+u8wHrb60xjw2q9LQVN+GgRe93UhtKm4ifMyMH7CEJxF2L3v0rKph0RNqyq6ckQ+NaxxHIXDljCF6MK+DsxasX5mPKV46I6kE1E/PQqAMgsA93E2P2kQ9iYEjs7YEBO0pTCXZdxVzYys9DLzhcr3idOMGx4fSY3ae8ZpVNOAecrVQYbUs242gsp1oCG1rxtNT8KkRZgs0jenCnSQ1fLZQV6Sa10+Qf0dD6JMmgvQqjNoasPjIyltU894/Y2dPEHWnj1UsonWFgUStEkpAMqYXigFr1cyepZAu9hyTOXeOStBVJ/dKkauYtfPV9HVepeLqdS7h/qoKt19Fg1wl7X9XZ2FBYmq03E0nOponCiLyrI0u/R9pskKVIuDvzIDpnIfdrfSCL8b3/loOwewTg1MUjZU3O/Kyei+QMEKVMnvT/JyXNt0TVtXjaAcif8klF1Lg/dLkTTecz0eJPDWHZyryllVh8NpVJV0EcMuM8MwFWSeQpbFf0LMCgPfG0bS0GcR8myYi8vs/HvPlvQeJvhj564vKw8hbO/Zgro8iZE8/u6baPmm2sRV2/0GDFKL0nHOLbWnzjk+mt/MV/Pp9fxf85tPXMDSmMVF7S0Cs0zeZs3Ms8XidsGGrf2RASnvZjdXEi91p7brYd/n4v7mRoI029f77gOSXi6my88SqFEW5s8Ds95+ubuerWZXfNh0swMfcCLSfpzOrwVQH+tPE0tzchM61POC9MCRxsSLIaGV5mzIYytDINZaOYB83dTLqTc1BCz/XQ72HgFnqfxw1NgU8CHVMsoM9p0wlYjZaWsIXC14JWKS41ihcmAvICO4FS0FBoLCy1UpuFX8GhTt8JcK225pINRCgpIYHwuVVHsJGUGzaDk1EFR8dpp2OubQrGP14Ng7HK0+ibsb9fCEdjbaNNRdjQ4PZ0ejjUPdzejgdI7+htun6oaxY+yIRDqIU0JPN9Wx9F2tl7US91zjZYE7t3IwBcATQiDG0rv9JYsL9bGMZPaZ+9IW8+xKo7eqgcdzA2Jk+UKFsLR+hyjPDoJyJNVLKpTzq9xWmLeTrAzPMZWDI8EngFwMTXHVqYLzYxl34H+qppXTjQuPTSsyjKdmL6slBNwgauOdGohODciQ5WRtIK8Biucs3T89U2AaUSaNIYOuWXpXKrt6cOySmbpPRnYFYMiCXceS4ZEm/aZwiJgLN9Q6aKIU/0FYD7StSWn4Kq1TG67gsWv6CNzG1gZAzoOsbRJppKdGBgF861hKKiPVagKTbhw+min1gzXm8HwDUfComVUCqr1JafhzD1HH3BKwTY1JA8torEGVVGNguYx6MxKQpvD8x/QB5EGUz40dnJ+7JMbm1diEQvMWCzUy12k4gXkLhhqX6zD0AsP2e6HsC7k4wGWFbQh0RaGD4DmujnjAilVaDGcxEQpg8WALQO4NgEsG271jd2Qc/YML8lr9o/cwHP3v8C9/J/f2EUWAbV2J3yJxMaBK7NoYpOo6BwmimK2FQUjJOxiqmyawBI0MtX9DoN222a44u3xu7DC76pIRZWPMEpqEbKGkixZMaPh6BRBY14ThyYjWTLIwwUA1xLvClCOYkAh2T3ZX3wBFMYaA87Ss345gIaXLCwxUNLM5xC69CY62QQ8CxG19G+BoJhZ2QRQDi2J3UXHz7LVdLu7xBuqH3yGCbvdLD6MPQ5WLpTUqRkDd5WJG1RoWI7TuYnVSbmGewvYku0gnUTmaSqeU2mWzIwG1pQWZvu1oM6kRZJGY/W19rXuc7vrhd/C8D/3y3G/M1KURcWYxwJr15jORkje1AaDtSU5lpM53lJ3D3ERyfvwdbJ3ITSStAcvZO6GbSIxsTJsndBOJEY1xE0mfjHYTiZ/rt/IJIlIjyqQxWxzMTSTnx9/B6gjcRAKcPKibSKxk1JtITA2C5hQZlDG9/ApehVn0PN2Gybc/FEDB9x8fS8Fbe0YqeMOAmQreToZV8E42ioK3o2EVvBOts0ZflPu6WwfWSZhJdAGa4SZl2n98LGVq6JmgTMk/FJWK95sBNdRVnL9U386sqhqyTX0Fs3+GGYRG1Vb2/ik6y/QKJDSXg5Kkv9ycZC3mwCTpMjemnnwPPfuePsCmAXmyvBaYb9fK+VVewHSsHoibdkQ4uxrYtYKtetggNKo2NvVP1cnUCcfj4889wN5GLRrE2jRkYnfalMbvGZh6DV2px/peEIhx6QiMaljMfVOMSnfYEgbFQkcyJnY+siGx4JGMiB1PWyDhweOhw7UakCWLYabDgoVcnXamrrGwrUaroegIjGokun1TDQR1MtHZ+PMKUk4BtQoeVt5kQ5mBxopA10Xz+DuYAL1nugE4DlhO/XfIGMq/z8ZU/R00huLvo+nlYKx5NKnEoV9VclOZ1WuXzqNcm8ffQbUee+YpVsCPBfkulh9s0m6KgojRVd57FfRHx9dR9LsVOoMU002c+xWsTDydxLljwYrU+cD3ZlOdyVv7zgrboBpx6DEkGBVSQ2q/HE07eu4K8N8ZbaFJI/jtXWCaK5UwgNYqkWZqziPT5lAjLDuD8vhpGxb7jKSOWrIMHqN19Z6C1x8d36pST8Ij1Q3k+KMTatJtCosIKNvHm37jyWei2YefeQfdNeiBbDUzDGSpdqRA203Jwzb6iD9D9YbkQfs6joTJUXdgl/QxhVYRnJ8d2SntdEvzSk/jlHFLu0xEv9RAxXBMu1BEz9QARdhe6+Pgdjb8HKjNNNM0IuyhGan6DkVvVTk8iuOzI7sUp27pPgVqopBoyHNmgE0wOyRt78sH21PWUEX9DkqaraAFlbOAYpZTygIKWaI818CCq8sFkDyk6csmzF6wIC05GQ73zQ8mAtgxWUDftfOL/ilOUiIMWX0VGZbhJCXDQJiQknPxKUv3OzTBSYrK0HUEoE7AOzgATOMvVfZtZ8HWextbAusqPB5VbQHgvOf+XVhoXQa4e1DXangomoIDXIOmqzo8GE3rAcB4U3+YSd9Ringsmn5Eebd3WbpTWRHDDdhZ4h083l7ndN+3NXI5L7jPx/CHjYRMz7gPyPCRjYA8b7nPR/ab/XRYD7oPRzVKADawV22gQtskPw/O0zZNM4pJ8nPhvO8+F80iAbhYk15svps9ZIPW9/jKZ4l38JpbnfP8Z6DCwnrSVj6GT21qU9C7tiPzVZqwx+1AZei5AbxwOyhX+Q3gmdthuRpR3Ft3oA6wsCyOcunEQNV5+eg7uMbnXuk+cTVIOWe4RcTwgnUmpvvbQmL4vTpSd4Of8npqKSmGx1gla7Dz0cI4CUqRPMdPz0n5H7jj2KLRhKWIPBfVmkmAF/FZCcxOWFujeLyv8tF3cLuqXnn+FnChUFCIa8ZvnDqrh8RGXkiQm0p7S4qEyFpdEreWuvFISw5g0KN9Fhee0PrwzGgmXOsOa7ub8XCNts6AttY9CpKZ1iHQ9rkHoZ8KW29i360bOsBJgt131DyKGv5Zht9/uo+e1w/TffF8u00ws3/SiIalaHoQZdNs1OZBZaif4ixC6f3Cvv6NdvfwzGgGt+mOYmlRUx7VP2H2AyLq7jrAIVGWBCjMr2Z4UE3xIG0vDySdoR1BzO6qwcERFhDYmN4+/KYikG47PDmyYdU6pZnXZoQyRlbnIZraHhHD4OpARLPbA+oVJoIUvs5yFBOiyNKEQnEUo1P0DVBnzTjM0OHJkY1R0yndJGGmAwGFOjMgqcmEiUacLgB1m6hqVX6OfY7k+bnRVG2vS6yibY2Nq2b7LGgla6Qhqdg+DFrBGmH6V0iED4n6CMj89YlO4pi0hZ/Kez25AQV8UzOg//2W+V5aDbDfzIV7HRsNwPk5wio+d3hZTbiwvZXl6+0kgdD7xlGfV++qPRnUdr+B9F4JkRDObbQnx9ke/ri8vaHTTH6D3stub8jMtZr9c8XgKtRXYHAE4aI5EK2WKe4DQtkFwEytlWhiaAr37kRur3cAUtQh4IMxW8F3aGxMAFjzfLLXw/daQTebdh4ezQcy94t1hLpD5XpDFiq0S2TnIvlFFiy0c2THMiV5iExHWTmeR1UfNPa4JBaglrA80cckfOJhPTYtyLG9qu2aOKFOopI0WU5UQpOzLIvnAqAbjU5e5+HR0grdfimuAXGp05BYqx6wydxd/0RKliqAYwaPmlZgwgZ0DeFH7ugKIipDbUAQdQVCZqTrEqDP9TNQ8R6eG9XT0rqkOFnN2CT8K52F5Fr1aMhelQ5Dcqh6MMjrKPoY8GsF/P2/huXb9eVA+whnMRkKqBfQocAu2h5F1/Z31qjV7B+eGyOT1OqNkkkyjvq8Mn/u/PyGNIkRoJEjgfjySXfT6ZIFNNmFIcIi2toS8dOaxqkuGkJ5oClIegRgkDtTCs9FVC6yvoIFjaZxAB5CXrVbFRWVDcURIDNjEBjNZ7D3jXUeTMPmehEOOrQ74eYj+RUOPLSD4cbTC5jOTylP3baDsNvKYIzlU1eeFBMMs/wrNPIkk34Ot+vEW4YH5n0+N8emvgDqGKPzYRAYLcth6ptiRtlLhA4otFr8hk2fPgEgYYODPzU60gCeu+tJbhjstQW15eAtlu7T41px/iZLb7Qi9ltim8VBRrfcEhstDjBtWaSe2xRsQCnwwDGUI/be+28jaSQFWfblJLgsPJdm2nAq4agA3nPoIOpZVfCmQffpce0pd9uAMHGJPOQ5DPlIUGs2U/HoExtQU9CZ4lRG1mz327nnMFvnUDPXfXgsK2fpF2nkekNl2jgbFdbEObgoFs6GhTVwDiz9Gtv6QdrvdxRl0VwAZrNJjXcfHkuL9/olKHHij0Mj4vxOXg20es7S/dPzbl8AtZBRYCRN5Oobp43Mw+ZpJCcdUiv5+AiayYmH1E4+PP1ynSSNXpwayol2Epel+n2vMufJUyfUUVqWKVOhM63oRGqEZYnesrigT/qjNJvpAqivDHbGKDCSrTH3jbc3nOVGJ+OuPL+Trq9BBilvOQJOYbUXJoOTtUb9mPpqZXDyFq7X6bjfAZ0N7cGRnAxTnzjnQh8ez6kw0iCdCRsPwYkw4iCdBxtO5+scyh3VWH4mBXOUYQxFWOwJEEcxMsWFZ6UYzJz24PBFNXp3+Koa28hbqRH95feKWGwEBzkaiK+s5st0frOa3UxvLmfBl9urGYtusgkrDb0Nt5EKyleMX8q9ds3UN7fXH3ik2zQB7VxR6G5/4rHBcpxgMoqbpzeOd+8IChEPQtSNgO8o6QuVQkZTmAA3Yx0WKr87fO3PrcfbT47maBg6xXoa2gi5roaJB+1rWIhIzoYJCO1tWID022zibbzZb/A0Z0Ehkl2mHlWWueuLzCxtUSGa+r5oPMlRjE5x4VvFRqek/eRIMX6nU4r2p0xQAgx9rgI+zdqbtRRAxgQGHH3WpjIFjzir/Xaq2qtMt81peftSOz82loXq9Yg0T62BMW1TnwRrmIwsFKvUR8GaJCOKfhuts27T9DZgDrq/Z99pGkPf0CJ4QO/eK7EM3YMvODL3f+FchyYzc35shEC71RkhzDaO+Lz6Ftrr7sdfxs5rIQqCL7xezKZXswUdp06vKuwS7DZlZvtlMV+x2OqU6jBs06svc8f1MV60+mrNQcgWs7vr+eV0dcv7VXdJVTiKVq4wxqsPwf3d1XQ1c5yY8jKuH4L9wegPwzhbzj9xfuLSWMZPw/zGy8/TxRXn3cHLG/Bss8v7cuH+yqE7X9ErxEeKMlotE0IMlMOBJcD7Hn5nHXAszwFEcEhkbmJ0MFG8FH/ksI/Xuf+z4K3Hxoocej0iI4fWwJiRQ58EGzkYWSiRQx8FGzkYUfTC1+oRJMVRhtj/hXM+mpza82NjZWlaPRL0J/a1YyFIv4BXO/wcq7d/7MuprgA6ovfwSJrC1i9OX/SHytMaViqk7nBxETSIFQupR1xYncKX6l+d+sTKdJZl8VwA5rNBx/QeHknT9PvF6xvyz0NDYv1SYC3kLLY8PTSy1qF95uY8JBktQ/3QjYmDoVWon7oxYehHU4tito3SKhk+9xyD67GUsqqRhZ4XgvCE0fNGeT4gbGJpyfE5yvf8mMQRkqItxWcop1zk3yA3zdSzGJ8i3kbJfq2u0gj3Lhq59UFOiCOPX9Vs69yANYNUgmoL2r3ykiTxJgY5bCeEowS/7/wl3uG050GA3/MhibZUv6O6b1JvtRSfofwFf1IoazUpRV4UKEUE7L1cCHPcBDwglAsB9qU6L8dTlu5xk+AoIdT3tXpVztIDM0DSiPEpXpCTQGoGlO3glGAjwO85U+t9hPNYTiICWqeoLu3G6Z2jiEjvWYFd97WQ1O9+JMCv/SOG3Oo/aFSCEqb23o/ynB/FOz00/A7suSv8/qtppN36xFPfvb0JU88HGTyAb+91tbh3lDN7SCZlsID75XvtmKk+Tq+XDKzHMMkH4bqe/suxp+TDSsI/cBrDRcXJUVA+8ggJroJjxBYA7omwwUxMDSHemf/CJEMUiEckBYSQr0B2Q0MkGi1K9IMZ4kUkGTF0hFxKUgeDwbodRSLhOm2I41UhYqC2vjpJN1+rEUlAPeREguGjT8DRgnYciuRBh6SAO2Vq3RvkregUCaW1IIlWToagHa8guc7iA0BVaynwfn/dx3ZuRRJRj3KRZPiAFwgUJFrsS8EK8HGwH44xw+RnlxYm42mktXsndkYCEcJo0MmsdkCNVaD42BqElBUcTdVuYBAwprYytCNvgnjmRwCps70Hqy4YvayAWU8gVkjAriCQKh1g1wy4d6Pr8zGL9M2bvdQ5arHsICZAAd5C6NRAYfcQPDvz6NfAegMXrvVoSWqNXhbBqocATL1Ae+lIjonWBAJJOG6w1IehAwcoHOudSb0toz0pNQlsBZUPjm5Vzn1SDUs1PCnb0qIhmxedh2VhWjhkI6Pj6LmxcJ+r9QfvVk0fphZ8APuOXhKVZYR3cpSSYchUmLtvUTJCnMSkKB4JCI9i/ZfeNn6p1DIy/cfeHbte9/DgwNs7YKu61z0ihvL2/xome7yqOkqRGUxeT9tqOB2f8sHRfZ+qT47741WKwQMksrbBTNqN4LAA2UBNVxLgaGoTdLlfW4ESyIi6FIL2yOPCK1jADlBL1RKgKFoXsLkCydhYmQiqWCpbamWi6GfIp+XampqARVPaXrf/8vB542XvczEm/8r+rEGnWl7E9H71efXr3Sy4vL2//Hz1IVjOlsv57Q26t/rrOMW3nQqaTzSXUVru/sKdY6wED9zHB3LBQUidkPtFbb+E2/BJEaBq6c1J+kxV5Os/x/mfd1laqOjwyScOZaZ+38eZWt/uqivDDCkZH+ixgfTUgCSrFva1P3VFm4Ytac7vrFFVhQTx0z4jILVFxXj0j1GtyoXHelflA8WhDR7h3//j+7/9AFFn3ZlY9e5EbgTgqq36Zol2gBrVxSQIqudbjaBfzLG5Q0s2zF3Z6luarVmYrUYEMduG6TncPqn8Y5ok6ZtJ0+n/7vyVwCrd0CZMjXdgbbmuapMK1uvxUX5/t1t1+2hIElh7TbcqfXQ4sNC+U0MZu7nT1LGbb+1N+55PUYYC/VsED38WmRqtpkAzoiGyvJzdPn92dtE8QGnb+DGDdtvOy9CPbf/3n0onda2+fvef/3P69vB/fvfDX/7PX/5ePv4Yq2Rdiv7X8cKIKN1U1XjlfyvDjH39X/+7eexnVb2o6uHD0//7r9/96b/++qf/+Otf/t/F9//933/6r6Nw/Q/1H45tnP9SC35f/q/v//Qff/vL3y/+rgl+3xP8XhP8ofxfP5gEf+gJ/qAJ/p//n697zXEd57UwPKEPjYikbmM585/H2RFdQNXyS/3sCKXecZYlW48u//7L6Q/99Yf+5w/j338F/WG8/jD+/GH/91/9f+7/NR9//rC//rD/+cPx778G/R/H6w/Hnz+c//5r0h/O1x/OP3+4/v3Xoj9crz9cf/7wX4L+b9Mf7tcf7r8B+OahfTAC7/A0Sc+JD+cHAvQ3Qe2bi4YZau8Qtb8pat9sNMxRewep/U1S++ajYZbaO0ztb5raNyOt4x+/A9X+Jqp9c9IwU+0dqvY3Ve2blYa5au9gtb/Jat+8NMxWe4er/U1X+2amYb7aO2Dtb8LsmxnDhNk7YfY3YfbNjGHC7J0wkzbqNFLcSkEz9Tdh9s2MYcLsnTD7mzD7ZsYwYfZOmP1NmH0zY5gweyfM/ibMvpkxTJi9E2Z/E2bfzBgmzN4Js78Js29mDBNm74TZ34TZNzOGCbN3wuxvwvybGceE+Tth/jdh/s2MY8L8nTD/mzD/ZsYxYf5OmEtPeLpC7guhM/ybMP9mxjFh/k6Y/02YfzPjmDB/J8z/Jsy/mXFMmL8T5n8T5t/MOCbM3wnzvwnzb2YcE+bvhPnfhPk3M44J83fC/G/C4puZwITFO2HxN2HxzUxgwuKdsPibsPhmJjBh8U5Y/E1YfDMTmLB4Jyzkees8cPETFzxy/U1YfDMTmLB4Jyz+Jiy+mQlMWLwTFn8TFt/MBCYs3gmLvwmLb2YCExbvhMXfhMU3M4EJi3fC4m/C+jczHRPW3wnrfxPWv5npmLD+Tlj/m7D+zUzHhPV3wvrfhPVvZjomrL8T1v8mrH8z0zFh/Z2wLk/157EeE9bhwf5vwvo3Mx0T1t8J638T1r+Z6Ziw/k5Y/5uw/s1Mx4T1d8L634T1b2Y6Jqy/E9b/Jmx8MzMwYeOdsPE3YeObmYEJG++Ejb8JG9/MDEzYeCds/E3Y+GZmYMLGO2Hjb8LGNzMDEzbeCRt/Eza+mRmYsPFO2JB3x/PyyG+P8Pr4N2Hjm5mBCRvvhI2/CRvfzAxM2HgnbPxN2PhmZmDCxjth42/C5jczExM23wmbfxM2v5mZmLD5Ttj8m7D5zczEhM13wubfhM1vZiYmbL4TNv8mbH4zMzFh852w+Tdh85uZiQmb74TNvwmb38xMTNh8J2zKCMUZouAxChik+Juw+c3MxITNd8Lm34TNb2YmJmy+Ezb/Jmx9M7MwYeudsPU3YeubmYUJW++Erb8JW9/MLEzYeids/U3Y+mZmYcLWO2Hrb8LWNzMLE7beCVt/E7a+mVmYsPVO2PqbsPXNzMKErXfC1t+ErW9mFiZsvRO2ZBzsDITxSBgMhf1N2PpmZmHC1jth62/C9jczGxO23wnbfxO2v5nZmLD9Ttj+m7D9zczGhO13wvbfhO1vZjYmbL8Ttv8mbH8zszFh+52w/Tdh+5uZjQnb74Ttvwnb38xsTNh+J2z/Tdj+ZmZjwvY7YftvwvY3MxsTtt8J2zLaeoZbebwVBlx1xDWHXIsxVxp0lVHXzxl2/fC46wcGXj8y8vo5Q68fHnv9wODrR0ZfP2f49cPjrx8YgP3ICOznDMF+4n8j/tvDpQIYhP3IKOznDMN+eBz2AwOxHxmJ/Zyh2A+PxX5gMPYjo7GfMxz74fHYDwzIfmRE9nOGZD88JvuBQdmPjMp+zrDsh8dlPzAw+5EkttKNGg3+v0b/c/ifg4wAIDlMAmgNU0AIoAqQDNDsf33/t3pIBZBDlYCkgAISCANUA5IDWnx9aX30K0AOVQSSBApQIBRQFUgWKFCBYEBlIGmggAXCAdWB5IG2vtegN5MKIIciBO0M+v/7FCsAJGiiBO0M/KPxNWCCJk7QLCmKgwxU0MQKmvklBcAFTbygHQJoDB0NyKCJGTS75RDYoIkbtEMBjbWkAR00sYN2OODfF/vfmP/F1F8Bcih+0GzdvgLkUAyhHRZozC4NGKGJI7RDA/+uzP+G/be7fAWghCaW0LxdvgJwQhNPaJ5J5JsZSKGJKbTDBP8u7f96+8+XNOrACk1coXkmcf1vtP9sdakAkii20A4X/Lu0mAPghSa+0A4Z/Lu0/wv/7/X3EEQhhubz8mwBytCEGdqRg38/DX8DCKJQQ/N9iwEEUbihHUFoDEsNxKEJObSjCNWvCOrQhB3akYR/4cCeFeShCT20SKEPvIigD034oR1R+BcOroCcXoJ4VOFfOrgCCKIwRIsMIneMIBFNKKIdXfiXjv/5v39BTKkAkigc0SKTyPcSiEQTkmhHGf6l43/93zOeaQWQRGGJdqThXzr+1+O/GVIByEQTmmhHG9pXsOApE3SiCU+0Iw7/0vG/WP99mlxEEIomRNGOOvxLx/9i/mcuTxegFE2YovWcL9L/F/2//pF7AaSiCVW03i+NMmhFE65ofVxuZxCLJmTRjkL8yye2iaAWTdiiHYmoWnWQiyZ00XomcWISQS+a8EUbn7pbAMBoIhhtZBAXBhEQo4litGGXbgEgo4lktJFB3PgjAGY00Yw2bm/NABpNRKONnLz0rzmw//qWHAFqNFGNNsalZwPYaCIb7WBFY6tsgBtNdKONdbkVADiaCEc7aFH1bIAcTZSjzc+lZwPoaCId7eBF1bMBdjTRjjbt0rMBeDQRjzZvSQT0aKIe7UDGd5UA3UwAH03ko81MonMFkETRj3ZAo7EeNwCQJgLS5q1zBgRpoiBt3jpngJAmEtLmrXMGDGmiIW3dOmcAkSYi0tatcwYUaaIibd06Z4CRJjLS1q1zBhxpoiNt3TpnAJImQtLWrXMGJGmiJG3dOmeAkiZS0tatcwYsaaIlbd06ZwCTJmLS1q1zBjRpoiZtXzpncJMmcNL2rXMGO2mCJ23fOmfwkyaA0vatSQRDaYIobd86Z3CUJpDS9q1zBktpgilt3zpn8JQmoNJ2ds48Fgmm0gRV2r51zuAqTWCl7VvnDLbSBFfsc+mcDXDFBFfsc+mcDXDFBFfsc+mcDXDFBFfsc0miAa6Y4Ip9Lp2zAa6Y4Ip9Lp2zAa6Y4IolrvAEKwNcMcEV+1w6ZwNcMcEV+1wGEw1wxQRXLHGFp3kZ4IoJrliurOB+xYBXTHjFklf6+l/3//aUawC8YsIrlryCjbKBrpjoiqWu9E19s4GumOiKpa6MD38DCKLoit10xUBXTHTFngUXxQICCKLoiqWuDPt+BRt6DSCIoivWbkEEXTHRFUtd4RlwBrpiuv4idaW4l2gJhq7BsMuottEyjNc6jBNEnodnuBRDkpi+Un0FSKKux0hfqb4CJFHXZKSv8GxAo2UZui4jfaX6CpBEXZuRvjIGPewbLc/Q9RnpK2OSbhgt0dA1GnYZ1jZapiG+YukrPDfRwFdMfMXSV4qLCL5i4iuWvjJOkzaaVgBJFF+x9JXJTRr4iomvWPrK/PfO9u99ZcnfQxCFVyx5Zdr/Yrzedwx4xYRXzC9PiQa+YuIrlr7CEyYNfMXEV+zxleJXhCCKr1j6ygxMMviKia9Y+srs/+vrv6HXAHzFxFcsfWWO73vvGvIzgq+Y+IqlrxS/AviKia9Y+gpP4TTwFRNfsfSV6hrQKjVJYvrKXPgrgK+Y+Iqlr0x+0AVfMfEVS19ZH64Akii+Yukrq/FXgCSKr1j6SpUDSKL4iqWvLL6dwVdMfMXSV3hyqYGvmPiKpa8UdyP4iomv2OMrOAZk4CsmvmKPr+AYkIGvmPiKpa/wGJCBr5j4ij2+ws/q4CsmvmKPr+AAioGvmPiKpa+soG4BeMWEVyx5hZ/1QVdMdMVSV4pnfeAVE16x5JXV8UEZeMWEVyx5pXjdAV4x4RVLXln/7sX9n5u0BsArJrxiySvFsz7wigmvWPJK8b4DvGLCK3bjFQNeMeEVS17hadcGvGLCKzZufTPwigmvWPJK0RoAr5jwiiWvFK0B8IoJr1jyStEaAK+Y8IolrxStAfCKCa/YwyvcGgCvmPCKJa9wawC6YqIrlrrCrQHgigmu2IMr3BoArpjgiiWuFK0B4IoJrljiStEaAK6Y4IolrhStAeCKCa5Y4krRGgCumOCKJa4UrQHgigmu2Lo9IwKumOCKJa7wOgoDXDHBFUtcKVoDwBUTXLHElbXxAQtwxQRXbN1aRMAVE1yxxBVe0WGAKya4YuvWIgKumOCKJa5U1wCSKLhiiSvFNQBdMdEVS13hhSkGumKiK7Zvz4igKya6Yqkr23BQHHTFRFds3wZwQFdMdMVSV3iJjIGumOiK7dsADuiKia5Y6soOHMABXTHRFUtdKXpG0BUTXbF965tBV0x0xVNXcPDCAVdccMUTV/a/bmH899qpA3bbEFvxz6VFdLAVF1vxtBVeceRgKy624p9Li+hgKy624mkrnAIHW3GxFU9b4RQ42IqLrXjaCqfAwVZcbMXTVooUwEYcQiuetFKkAPbiEFnxdmkPHWTFRVY8ZYWXjjnIiouseLu0hw604kIrnrRSpABoxYVWvF3emR1oxYVWPGmlSAHQiguteNIKpwBkxUVWPGWFUwCw4gIrfoMVB1hxgRV/drXi/WQAVlxgxW+w4gArLrDiCStFCgBWXGDFE1aKFACsuMCK22XsxgFWXGDFrR7OdnAVF1fxdBVOAbCKC6u4XZ4PHVjFhVU8WYUXczqwiguruF2eDx1YxYVVPFmFTcKBVVy3v/LcYe1D15A2wNIdsPwymO20CZbugpWqwibhtBHWayesy/opx82wJIZHSYyXxDptiKU7Yj2sUlwDCKLuipWswgO5Thtj6c5YR0mMF+U6bY6lu2PdWMVpgyzdIctvQaRNsoRV/GEVfON1YBUXVvFklaI9A1ZxYRWPy3xEB1ZxYRVPVuHBIwdWcWEVj0yi0xQoB1ZxYRV/WAVbVFAVF1XxgyT2CZpC5aAqLqrikUHs/A0giKIqnqpSNAegKi6q4nF5QARUcUEV79kgDvwGgCouqOL9MuPBAVVcUMWPkRgvDndAFRdU8X6Z8eCAKi6o4okqxc0MqOKCKp6oUtzMgCouqOL99qICqOKCKt5vLyqAKi6o4okqxc0MquKiKn6UpLqZgVVcWMXH5YUZVMVFVfwgSXUzg6q4qIoPu9zMoCouquKpKsXNDKrioiqeqsI3M6CKC6r4MZLqZgZUcUEVv6GKA6q4oIqPbBD5RQFQxQVV/IYqDqjigio+bj0zoIoLqvi89cyAKi6o4vPWMwOquKCKz1vPDKjigio+bz0zoIoLqvi89cygKi6q4vPSM4OquKiKz1vPDKrioio+bz0zqIqLqvi89cygKi6q4vPSMwOquKCKr1vPDKjigiq+bj0zoIoLqvjKBpHf9wBVXFDF161nBlRxQRVft54ZUMUFVXzdemZAFRdU8XXrmQFVXFDF161nBlRxQRVft54ZUMUFVXzdemZAFRdU8X3pmcFUXEzF961nBlNxMRXft54ZTMXFVHzfemYwFRdT8X3pmYFUXEjF961nBlJxIRW/LVhxIBUXUvEjJMY7EDmQigup+L71zEAqLqTi+9YzA6m4kEo8pIJzGQNMJcRUIk2F5/EFoEoIqsQng0jDRwGmEmIqkabCQycBphJiKnGIxHgbqABTCTGV+FzmxAaYSoipxOcSxABTCTGV+GQQeZ9uMJUQU4nHVIpfEfaeFlSJRBWejRmgKiGqEqkqPBszQFVCVCVSVXg2ZoCqhKhKpKrwbMwAVQlRlWi3JIKqhKhKpKrwIF6AqoSoShwkMd5PLEBVQlQl2kWZA1glhFWiZRKD5r0EuEqIq0S6Cj9dBLhKiKtEuywTCHCVEFeJPDGEt0QLcJUQVwm7LBMIcJUQV4k8OaS4iOAqIa4SeXoIt6nAKiGsEg+rcJLBVUJcJezWJAKshMBK3GAlAFZCYCXyMBHely4AVkJgJRJWqmsAQRRYiYSV4m4GWAmBlUhY4Z3xAmQlRFbitl4lQFZCZCX8FkSQlRBZidt6lQBZCZGV8As0B8hKiKyEX6A5QFZCZCVSVvhdIUBWQmQlHlnBd4UAWQmRlfB6wkMArITASni+rOC7QgCshB4/EvnajO8KQSeQ6BEkz3oVvhXoFBI9hiRhBd8Vgg4i0ZNIIhtEfFcIOozkdRrJZQJY4IEkksPIrpkP96BDSfRUkrh1zXQwiZ5MEreumQ4n0dNJjpNY40c0OqBETyiJXXdLdEaJwErkapWiSQZYCYGVOE5SPeoDrITASvQLNQfASgisRL9QcwCshMBKHCcx3iw0AFZCYCX6hZoDYCUEVqJfqDkAVkJgJY6TGO82GgArIbAS/fLaHAArIbASCSvFrQCwEgIrMS5zwAJkJURWImWF9zsNkJUQWYlxmQMWICshshLjMvcmQFZCZCXGrWsGWgmhlRiXdVMBtBJCKzEu66YCaCWEVmJc1k0F0EoIrcSo100FyEqIrMSo100FwEoIrMS8rJsKgJUQWIl5WTcVACshsBLzsm4qAFZCYCXmZd1UAKyEwErMy7qpAFgJgZWYl3VTAbISIisxby8rICshshIpK3zcY4CshMhKzFuLCLISIisxL6sEAmglhFYiacV4IBFoJYRW4kYrAbQSQiuRtMInVwbQSgitxJGS8itAEoVWImmlGAQDWgmhlXjWq/AQFNBKCK3EkRLjDZwDaCWEVmJddr4JoJUQWom1Ll0r0EoIrUSuV+F9qAJoJYRWImml6NjAVkJsJfYFmwNsJcRWIterFB0b2EqIrcS+bKMdYCshthJpK0XHBrgSgiuR61W4YwNbCbGV2PUu2gG0EkIr8ewFxh0b0EoIrUTSStGxAa2E0EokrRQdG9BKCK30T7aIuOFJB1rpQiv9k8+IuJ1ZB1rpQis9acWwUe9gK11spX8ufXMHW+liK/1z6Zs72EoXW+mHSuxfjt457EArXWilHykxb/wPeAexC630XK7CDwcdaKULrfQjJf8izD/CO4hdaKUfKTH37/vWen2FdxC70Eq/LVjpQCtdaKUfKTE+7rcDrXShlX6kpPoKQCtdaKUfKTHvFAOQlS6y0g+UmA/8e4ihwEpPWPGJfw8xFFfpLWPIB2+Cq3Rxld4u/XIHV+niKr1d+uUOrtLFVXq79MsdXKWLq3S79MsdXKWLq3S79MsdXKWLq3S79MsdXKWLq3S79MsdYKULrHS79MsdYKULrHSr++UOrtLFVbrV/XIHVunCKt0u/XIHVunCKt0u/XIHVunCKt0u/XIHVunCKt1v/TKwShdW6X7rl4FVurBK91u/DKzShVW63/plYJUurNL91i8Dq3Rhle6XfhlUpYuqdL/1y6AqXVSl+61fBlXpoirdb/0ysEoXVul+65eBVbqwSo9bvwys0oVVemS/zCcyA6t0YZUet34ZXKWLq/S49MvAKl1YpcelXwZV6aIqPS79MqBKF1TpuVol+OBzQJUuqNJvZ6x0QJUuqNLj1i8DqnRBlR63fhlUpevR788eYNwa0envevz7bblKpxPg9Qj4XK4SfII8nQKvx8Dflqt0Oglej4JPVSl+BToN/nUc/GX37I4nwksSH1UpfgVIoh4Ln8tVql8BkqhHwx8ksUCS6HQ6vB4P/2wCVvwKkERRlX6QxP49Ib59sAOqdEGVPm5BBFTpgio9l6sEv+gAqnRBlT5uQQRU6YIq/RhJdQkgh2IqfVymO3QwlS6m0sdlcnYHU+liKv0xFX7IBlPpYir9OWKFH7IBVbqgSh+X4wQ6qEoXVempKvyQDajSBVX6c8IKPmSDqXQxlf6YCj9kg6l0MZX+mAo/ZIOpdDGV/hywwg/ZYCpdTKWnqRRPqGAqXUylp6kUT6hgKl1Mpc/bAyKYShdT6fOyw0MHU+liKv0QiQWCRAdT6WIqfV12eOhgKl1MpR8iKVoTIJUupNJv56t0IJUupNJv56t0IJUupNJv56t0IJUupNJv56t0IJUupNKf1SrcmgCpdCGVnqTCrQmIShdR6c8OYNiaAKh0AZX+gAq3JgAqXUClJ6gUrQmAShdQ6ftylEAHUOkCKj1BpWhNAFS6gEpPUClaEwCVLqDS9+UsgQ6g0gVU+r6cJdBBVLqISt/5qoK014FUupBK37dXFSCVLqTS96pbExCVLqLS92XWTQdR6SIqI0Ulzr28/36BAaAyBFRGgkosWuUwAFSGgMpIUIlNbcEAUBkCKuP4iHVcpDAAVIaAysjFKh1nsA0AlSGgMhJUunEF7xwOEZWRotKdK3jncIiojFys0vGkogGiMkRURi5W4RZ5gKgMEZWRotI7/wveQRwiKqPV500NAJUhoDISVPrAbwCgMgRURoJKn3ArDvCUIZ4y2mUa4gBQGQIqI0GlI2gMEJUhojJSVIpvADEUURntMgtxgKgMEZWRK1U6Dp4NEJUhojLaZc7NAFEZIiqj7bI9HQAqQ0BlPAtVsD0dACpDQGVYq9tT8JQhnjJynUrRnoKnDPGUketUivYUPGWIpwyLS3sKnjLEU4b1S3sKoDIEVIaNS3sKojJEVEYuVCnaUxCVIaIyDpBU7SmIyhBRGXZ5Xx4gKkNEZaSoFO0piMoQURlevzAPAJUhoDISVIr2FEBlCKgM97o1Ak8Z4inDL8sDBnjKEE8Z6SkDB6IHgMoQUBkJKsU3gBiKp4z0lKI9BU8Z4ikjPYXPuhrgKUM8Zfhl+HCApwzxlBH18OEAThnCKSM5pWhPgVOGcMrIVSo8CDyAU4ZwyojLnOwBnjLEU0Zc5mQPAJUhoDLiMid7gKgMEZURlznZA0RliKiMuMzJHiAqQ0RlRD0newCoDAGVEfWc7AGeMsRTRr/MyR7gKUM8ZfTLnOwBnjLEU0a/zMke4ClDPGX0nAmLRD7AU4Z4ynhWqSCRD/CUIZ4yDo8URD7AU4Z4yng8BYcMBnjKEE8Z6Sk8ZDDAU4Z4ykhPQSIfwClDOGUkp/CQwwBOGcIpIzmFhXuApwzxlJGLVJiHB3jKEE8Z47Jh9gBPGeIp4/DIv6uPnQp4yhBPGekp1VeAIAqojNz/C4V7gKcM8ZQxcqIDCfcAThnCKSN3/0LhHqApQzRljOyWcWnBAE0Zoilj3Lpl0JQhmjLmpVsGTRmiKWPeumXglCGcMuatWwZOGcIpY966ZeCUIZwy5q1bBk4Zwilj3rpl4JQhnDLmrVsGThnCKWPeumXglCGcMualWwZNGaIpY166ZcCUIZgy1q1bBkwZgilj3bpl0JQhmjLWrVsGTRmiKWPdumXQlCGaMtatWwZNGaIpY926ZdCUIZoy1q1bBk0Zoilj3bpl4JQhnDLWpVsGThnCKWPdumXglCGcMvatWwZOGcIpY9+6ZeCUIZwy9q1bBk4ZwiljZ7eM8yQGcMoQThn71i0DpwzhlLEv3TJoyhBNGfvSLQOmDMGUsS/dMljKEEsZaSl8oO8ATBmCKWPfumXAlCGYMj91tzwBU6ZgysyNv6LR6QETMGUKpszElIF7MkzAlCmYMj+X0cMJmDIFU+bngssTMGUKpszElEGDLhMsZYqlzOcwlQ9/g3cMp1jKfA6qp05xAqVMoZSZlMKd4gRKmUIp86EUHHmbQClTKGW2bA1xIvAES5liKbNdWsMJljLFUmZayli0PcoETJmCKfOGKRMwZQqmzMSUgRQxAVOmYMp8MIV/BdCUKZoyc33K/OC9CJoyRVNmaspsXAEkUTRl5vqU6meEJIqmzNQUbNEnaMoUTZmpKdijTMCUKZgyE1OwR5iAKVMwZSamTHzVnYApUzBl3k6pn4ApUzBlWj33cIKlTLGUmWtTih4BLGWKpcy0lKJHAEuZYikzLaXoEcBSpljKtMvGsBMsZYqlzEMjRY8AlDKFUmaeUV/0CEApUyhlXihlAqVMoZTpl7mHEyhlCqXMh1K4LQJLmWIpMw9TKXoEsJQpljKftSnclIClTLGUmZZS9AiAKVMwZfplLvYETJmCKTMxhQ+5n4ApUzBl+q1fBkyZgikzMaXoEUBTpmjKTE0pegTQlCmaMm+LUyZoyhRNmc/iFOwRAFOmYMp8FqdgjwCWMsVS5mVxygRKmUIpMxenTHzLmkApUyhl3hanTKCUKZQyo57xNYFSplDKTEopegSwlCmWMvMolaJHAEuZYikzd/wqegSwlCmWMvtlzegES5liKTMthXsEoJQplDKf4+m5RwBKmUIpM5emcI8AkjJFUmZKStEjgKRMkZSZ+30VbRFIyhRJmY+kcI8AlDKFUma/LNWbQClTKGUmpRQ9AlDKFEqZt6UpEyhlCqXMXJoyccBgAqVMoZQ5bv0yUMoUSplJKUWPAJQyhVJmUkrRI4ClTLGU+VgK/4yAKVMwZT6Ygj0CYMoUTJmJKdwjgKVMsZQ5dt0jAKVMoZSZlDJxDvAES5liKXNedoSdYClTLGU+56hwiw6WMsVS5vRLiw6WMsVSZp6jUrToYClTLGXeLGWCpUyxlJkHqXCLDpQyhVLmQyncogOlTKGUOesVARMoZQqlzHlZETDBUqZYyszNvoq2BCxliqXMXJhStOhgKVMsZa7bwyFYyhRLmWkpRYsOljLFUmZaypxcAeRQLGWuy4qACZYyxVJmbvY1cQ7uBEuZYilz3TpmsJQpljLTUoouATBlCqbMPEel6BIAU6ZgynwwhXMAmDIFU+aDKdglgKVMsZSZ56hwlwCUMoVSZlIKdwkgKVMkZaakTB47BEmZIikzF6YUXQJQyhRKmbnVV9ElgKVMsZSZllJ0CYApUzBlPgtTuEsATJmCKfM5mZ67BMCUKZiyElOwS1iAKUswZT2Ygl3CAkxZgikrj6bHLmGBpSyxlJU7fXGXsMBSlljKehamYFuywFKWWMp6dvrCLmEBpizBlPW5PB0uwJQlmLJyYQp3CQs0ZYmmrNzqi7uEBZqyRFPW53J2xQJNWaIpKzVl4TTiBZqyRFPWbWXKAk1ZoikrNYW7hAWaskRTVm71xV3CAk1ZoimrXWx5gaYs0ZT1bPZFXcICTFmCKevZ7Iu6hAWWssRSVqtteQGlLKGUlZSycCb2AkpZQimrXWx5gaUssZT1bPWFXcICTFmCKSsxhbuEBZqyRFOWXVbqLdCUJZqynqPpsUtYoClLNGWlpnCXAJqyRFPWoyncJYCmLNGUddnqawGmLMGUddvqawGmLMGU9SxM4bYEMGUJpqzElKJLAE1ZoinLL0+HCzRliaas3Oqr6BKAU5ZwysqVKUWXAJyyhFPW7Wz6BZyyhFNWcspCV1zAKUs4ZfkFlxdwyhJOWX7B5QWcsoRTll9weQGnLOGU5RdcXsApSzhleY3LCzRliaasqHF5AaYswZQVNS4vsJQllrLSUhZ60gJLWWIpKy64vABTlmDKuh2gskBTlmjKSk1ZqCELOGUJp6zbASoLOGUJp6w8QAWXSy7QlCWasm5bfS3glCWcsvL8lNWxRQZOWcIpK5em/OtWqV8GTlnCKSs5hadvLuCUJZyy+mXq4QJOWcIpKzll4aFYCzxliaesXJpSfQUIonjKyqUpa9FqxwWgsgRU1vER+2719S+I2jMDqCwBlZWgsj80g3QBqCwBlZWgsvkJEUBlCais21ZfC0BlCaiscVm7vABUloDKGrckAqgsAZX17PWFdzN4yhJPWePWMYOnLPGUlZ6yuWMGT1niKSs9pboEEETxlJWeUiQZPGWJp6z0lCLJACpLQGUlqBRJBlFZIiorRWVzxwaksoRUVpLKDlrDvoBUlpDKyuUpxVcAUllCKmvemkQglSWkspJUNtLgAlJZQiorSaW6BpBEIZV1hMT2wBwAqSwhlZWksidXAEkUU1l5gspeXAEkUUxlzUwiRxlQZQmqrGMk/vlwBZBEQZV1jMQ/DSsAVFmCKusYiX+MK4AkCqqsYyT+PamQKoAkCqqsYyT+Ca4Akiioso6R+PekQaoAkiioso6R+IeTCKiyBFXWMRL/cBIBVZagyjpG4h9OIqDKElRZx0j8w0kEVFmCKusYiTdOIqDKElRZx0i8cRIBVZagyjpI4o2TCKqyRFXWURJvnERglSWssg6TeOMkgqsscZV1mMQbJxFcZYmrrMMk3jiJ4CpLXGUdJvHGSQRXWeIq6zCJN04iuMoSV1mHSbxxEsFVlrjKOkzixkkEV1niKvs4iRsmcQOsbIGVfZzEDZO4AVa2wMo+UPLv6YoreCdxi6zsAyVumMQNsrJFVvaBEjdM4gZZ2SIr+0CJGyZxg6xskZV9oMQNk7hBVrbIyj5Q4oZJ3CArW2RlHyhxwyRukJUtsrIPlLhjEjfIyhZZ2QdK3DmJICtbZGUfKHHnJIKsbJGVfaDEnZMIsrJFVvaBEndOIsjKFlnZB0rcOYkgK1tkZR8pccf5SxtoZQut7Nv59BtsZYut7Nv59BtwZQuu7MQVfG3cYCtbbGU/m37hnlkbbGWLrexcp8KyscFWttjKTlvhPbM22MoWW9lpK7xn1gZb2WIrO7f94j2zNtjKFlvZz7ZfuGfWBlzZgiv72fYL98zagCtbcGXbZVfYDbqyRVf2s+0X7pm1QVe26Mq2ehLYBlzZgivbLisENuDKFlzZz65fBFwbbGWLrWzPBnHSqP4GW9liK9uzQVz/m/++QTSpAHIotrI9G8TNFUAOxVb2oRL/Hh9BFUAOxVb2oRL/nnxAFUAOxVb2oRIP44sIORRb2belKhtsZYut7EMlHjgCs8FWttjKfpaqcI4gh2IrO49R4Z3LNuDKFlzZB0ucd/3foCtbdGXnvl9FrwS6skVXdq5UKXol0JUturJzqQr3SoArW3BlJ64UvRLgyhZc2c9BKtwrAa5swZWduFL0SqArW3Rlp64UvRLoyhZd2akrRa8EurJFV3YuVil6JdCVLbqyU1eKXgl0ZYuu7GexCvdKoCtbdGWnrhS9EujKFl3ZuVqFeyXAlS24svsFmzfgyhZc2b3eB3GDrWyxlX2opOqVwFa22Mo+VFL1SmArW2xl933plcBWttjKPlRS9UpgK1tsZY926ZXAVrbYyj5WUvVKgCtbcGXfcGUDrmzBlT2yZ8Yx8Q24sgVX9qj3J95gK1tsZY/L/sQbbGWLrexDJc77vW+wlS22ssdlf+INtrLFVva47Ne+wVa22Mqe9X7tG2hlC63seVk0tYFWttDKnplDxOINtLKFVva8THvYQCtbaGXPy8FSG2hlC63spJXiGkIORVb27Wz6DbKyRVb2zBziKoMNsrJFVnauVhlnHtlo+hUghyIrO5erTNxxaYOsbJGVnVt/FdcAZGWLrOyUlcBJ9htkZYus7Nz6q7gGICtbZGWvW4MIsrJFVnbKSseZwRtkZYus7JSVzp0CyMoWWdnrlkSQlS2yslNWOoL5BlnZIis7ZaV4QANZ2SIrO/f+muO7EeAaSyqAJIqs7H1LIsjKFlnZKSud31VAVrbIys69v4qvALKyRVZ2HqVSdGwgK1tkZaesdO6aQVa2yMrOFSvFzQSyskVWdm7+9flQ3w6wsgVWdp6kUl1DCKLAys7D6WdxDSGIAit7XxYKbICVLbDSPikrHR8vntK/Vfz+8KeOVl+Hp/RVR9M6rI7TU/qqw7SOM47TsZt/Sl91uNYRdaie0lcdoXX0uqN6Sl91dK0jBxZxq9Cn9FXH0DpygSnuV/qUvuqYWsdlJ5yn9FXH0jrOA+R3PsH7NeApfdWhOc2jVmaDma9PoVbRNKa5puUTNAf7KX3VoTHNZS3fiQn0VUBffn/4U4fXd/1T+qpDY3pEpe0OTddT+KpCU5rLWz64tuIpfdWhKW2XvvwpfdWhKW3ZneOD5VP6qkNT2i7Plk/pqw5N6QGW4qngKX3VoSlNlMEe5SnUKkxTatfGFFzm94c/dZyUNhwDe0pfdWhK7ZpS0JnfH/7UcZns/ZS+6tCYWj5v4jP3U/qqQ2OaSlNeU4qpaUztcjDGU/qqQ2N67MX5dI+n9FWHxtTq/Y+fwlcVmlK/bIH8lGodrjFNtRn4GvCUvurQmPplxuNT+qpDY5p2wzvDP6WvOjSmyTfld6GYusY0Bee7vzrWQTF1jWkizgha5/SUvurQmB6W8YEjt0/pqw6NaVLOwIkiT+mrDo3p0Rkfs7gelFPXnB6g8YFDqE+p1hGa00SdgaOoT+mrDs3pYRqfxW0LsPP7w586/NZDge38/vCnjmtzCr7z+8OfOk5OJ075f0pfdWhOo15R+BS+qtCYxmVR4VP6qkNjmge8lJeDYhoa02M3zrttPqWvOjSmPV+hiuYDwOf3hz91XIY4n9JXHRrTnjFFgX1KX3VoTPtlfOkpfdWhMT2W47xf3VP6qkNj2i+bojylrzo0pod0nLfKekpfdWhO+2XrvKf0VYfmNCVoFg/aQEG/P/ypI3M6uVkHDfr94VNHetDE2XdPqdYxNKdJQnPzvwNM6PeHP3Vcu31god8f/tRxun3e4OApfdWhOU0bqn4XwKHfH/7UcZrThdMBn9JXHZrTIz6+cEbgU/qqQ3OaSrRwUuBT+qpDc3rcxxfOC3xKX3VoTg/9+MKpgU/pqw7N6eEfX8XjB4DR7w9/6jg5XXhExlP6qkNzmmr0XRaFdVBOp+Z0Zk6LtxeQo98f/tQRtzYI8Oj3hz91XNtTAKTfH/7UcXK6i3sODOn3hz91XNtTYKTfH/7UsW5tIUjS7w9/6ti3ex8w6feHTx3r2p6CJ/3+8KeOa3sKpPT7w586ru0pqNLvD3/qODnllaBP6asOzem6tqdgS78//Knj2p4CL/3+8KeOa3sKwvT7w586ru0pINPvD3/quLan4Ey/P/yp49qeAjX9/vCpY1/bU9Cm3x/+1HFtTwGcfn/4U8e1PQVz+v3hTx2Z0+J5Hdjp94c/dVxfo0Cefn/4U8fJKa83fUpfdWhOc2HPLvIBAPX7w586Tk6/az7p3QMM6veHP3WcnO5R1EE53ZrTG0Q9pa86JKctKWoz3zSiqKYU1T6XjU2f0lcdTeu4IP1T+qrDtI7MKS6pfkpfdbjWceaM8GByI4lqKlHtKlGNJKqpRLWUqGIguJFENZWo9rnMLn5KX3VMrSNjyo9SjSSqqUS1z2W/gqf0VYfGNCWqigdRVFOKarkIqIoHUVRTimoPRXE8SKKaSlS7SlQjiWoqUS0lqhhbb0RRTSmqtdvTaSOKakpR7bhSfPjptBFFNaWo1i6g/5S+6tCYJkUVTtCIoppSVDuuFB9+GmtEUU0pquXea1XUyaKaWlRLi6qiThbV1KLagaUy6mRRTS2q5UKh79pJeHJoZFFNLarZrTUlimpKUc2urSlRVFOKapYx5YfTRhTVlKJaUlR12xJFNaWoZrfB00YU1ZSimmVM+SGokUU1tajm15iSRTW1qObXmJJFNbWo5teYkkU1tah2YCl424On9FWHxtSzOe20AuMpfdWhOc2d2oqoE0U1pajm106fKKopRbXbkqKn9FWHxvS4Unx4DLcRRTWlqObXTp8oqilFtbh2+kRRTSmqRbs1H0RRTSmqxe1dvxFFNaWoFhlTnvLViKKaUlSL25hUI4pqSlEtLvP3ntJXHZrTuMl+I4tqalEtrjkli2pqUS0yp8W7C1lUU4tqcZlV+pS+6tCc9ssiuKdU61CLageW4sMTchpZVFOLav2yFO4pfdWhOe03Mm1kUU0tquUub9WTA1lUU4tq/drtk0U1tajWb9P5GllUU4tq/Tadr5FFNbWolju+FXPgGllUU4tq/fau38iimlpUO7AUn+JljiyqqUW13Pqt+m3JoppaVEuLmjwm1ciimlpUy0VKxRhuI4tqalHtwFJbuOzxKX3VoTk9sNS+Y6f4XSinalHtwFK04i2KLKqpRbVxG+NvZFFNLaqN24S+RhbV1KLayPa0ygflVC2qzc/tcYwsqqlFtXmb0dfIoppaVLttDveUvurQnB5Yila8VZJFNbWoNq+Pp2RRTS2qpUVV9xxZVFOLarmcqbrnyKKaWlRLi6ruObKophbVclFTdc+RRTW1qDav/T5ZVFOLauva75NFNbWodmApGo+tN7KophbV1rXfJ4tqalFtZU6L10qyqKYW1dZtjL+RRTW1qHZgKRrPY2lkUU0tqq3LRjVP6asOzem6Pp+SRTW1qHZgKVrxHkUW1dSi2rq+R5FFNbWotq/vUWRRTS2q7dtcqUYW1dSi2oGlaMU7EFlUU4tq+zZXqpFFNbWodmApWvHeQBbV1KLavo6ekkU1tai2s98vnvnJoppaVNvXnJJFNbWotjOnxXMhWVRTi2oHlsJwJ9an9FWH5NQ+lwV6T6nUYWpRdmApjPtbI4sytSg7sFR9FyOLMrUoO7AUZuh7RhZlalF2ZCmMF0cYYZQpRtmRpTBuT40wyhSj7HNbcGKEUaYYZUeWwrgtNMIoU4yyz2341AijTDHKPplTboOMMMoUo6xdc0oYZYpR1jKnPFXbCKNMMcpaPp+u77+jN9M6KKeqUZYa9e/e5zoop6pRdmipf2torncLWZSpRVnLlHJLaGRRphZlaVHGrZiRRZlalB1YCuc3MSOLMrUoO7AUzjOTjSzK1KIsLcqL1oMsytSi7MBSOC+OMLIoU4uytKh/ddDIhZFFmVqUHViK786HMEPJyKJMLcrSohq/eRhZlKlFmd0WmRphlClG2ZGlcJ75YYRRphhliVHOMz+MMMoUo8wyp0XrQRhlilFm9WaKT+GrCo1pWpQXty1ZlKlFmWdMea2IkUWZWpQdWIrAQ26e0lcdGtMDSxE8Cc7IokwtytKiAnexekpfdWhMDyxFFLctWZSpRdmRpfhuqoZ1UEwVo+zIUvAmPk/pqw6N6ZGliCLqhFGmGGWJUVFEnTDKFKPsyFLwDmtP6asOzemRpYgip4RRphhlR5aC9wF5Sl91aE6PLEVv5IxGFmVqUZYW1YvehSzK1KLswFJ0Hi8wsihTi7K4nKHxlL7q0JgeWArek+MpfdWhMT2wFLzx2lP6qkNjmuui/v203f7rW5sgsihTi7LYt2dCsihTi7IDS/Hdw63950vrIIsytShLi6qaQrIoU4uynjHld2wjizK1KOuZ06J7IYsytSjrmdPiqZAsytSi7MBSDNy/+il91aE5TYuq8kEWZWpR1uetayCLMrUoO7AUo3g/JosytSg7sBTF8l8jizK1KEuLGkX7QRZlalGW66KKJbNGFmVqUXZgKUbRfpBFmVqUHViKUXSVZFGmFmXjcjLWU/qqQ3M6MqfFuy1ZlKlFWVrUKO5bsihTi7IDSzGK+5YsytSibGROi/uWLMrUouzAUhRLiI0sytSi7MBSzPZ9ux0fcQIjizK1KDuwFMV6VyOLMrUoO7AUxTpTI4sytShLiyrWiBpZlKlF2YGlmMUbEFmUqUXZgaV/N2xRB+VULcoOLMUs+kqyKFOLsmddVPF2SxZlalE2822/eLslizK1KJuZ0+J+IYsytShbmVM8pOEp1TrUoiwtauHepU/pqw7N6YGlWMXoB1mUqUVZWtQqnk/Jokwtyla9KfNT+KpCY5oUxed2PqWvOjSmx5ViFW9iRFGmFGUru/3i7ZYoypSiLCmqeqQjijKlKFv5FlW83RJFmVKUHVeKVXSVRFGmFGU7H0+La0oUZUpRlhS1iq6SKMqUomzn237RjBFFmVKUJUWtohkjijKlKNv5tl+83RJFmVKUJUUt3vXDiKJMKcqOK0Wx7NaIokwpypKiirdbkihTibKUqF20YiRRphLlh5WiWJnpJFGuEuWHlaonOieJcpUoT4kqVt45SZSrRHlKVPF26yRRrhLluUFf8fbiJFGuEuUpUZvfXpwkylWi/JEoFg8niXKVKH+WRbF4OEmUq0T5YSUWDyeHcnUo/9y81MmhXB3K2+d2RcmhXB3K06GK8QInh3J1KG83L3VyKFeH8nbzUieHcnUobzcvdZIoV4nylKjied9Jolwlyh+Jqq4HpVQlylOiNndyThLlKlGeq6Kqu4UkylWivO3b3UIS5SpRflipuFvIoVwdyg8qBe+86MRQrgzlyVDVBSWGcmUoN7+FgxjKlaH8mFL5VSijqlCeClWsHXZSKFeFcru2pKRQrgrldm1JSaFcFcrt0pISQrkilOfefMUMbSeEckUozwVRxUxxJ4RyRSjPBVHFpq1OCOWKUJ6b89nk1pgQyhWh/IhScQ7JU/qqQ0OaC6L+vbbAxq9OBuVqUH5AqdivzImgXAnKcz1UsV+ZE0G5EpTneqh/Lxy0vZ8TQbkSlHuO7S9ci+BEUK4E5bkeqnoaJIJyJSh/1kMZfxciKFeC8lwPNXhdhRNBuRKUJ0FV7Q8ZlKtBeVybUjIoV4PyNKjNL09OBuVqUJ7roao7nwzK1aA810NVdz4ZlKtBea6Hqu58MihXg/JcD8XncD+lrzo0p2lQm5nTyaBcDcpzPVRx6xNBuRKU59Z81a1PBOVKUH48qX+KxzAiKFeC8uNJnc8Ff0pfdWhM81im6tYngnIlKM/lUNWtTwTlSlB+PKkXq6CdCMqVoPx4Uv8UrxxEUK4E5f36WEoE5UpQ3q+PpURQrgTl4/JYSgDlClB+NKkXC7ucAMoVoHxkSnlxhxNAuQKU52KoqpMjgHIFKD+aVP6yBFCuAOXj+vJEAOUKUD4ypaO4ppRSBSgf83pNKaUKUH40qWw9CKBcAcrzEKd/7xz876CUKkB5Loaq7hYCKFeA8ucsp+JuIYByBSg/mlTcLcRPrvzkx5LsX0qxTSd+cuUnn5lS3obOiZ9c+cnzVKfqVyF+cuUnT36qhk2In1z5yY8l1deDUqr85LktX7H7gRM/ufKT57Z8n+KxgfjJlZ88t+Xjs+KfUq1D+clzWz4+Z/wpfdWhKT2WVJwU/pS+6tCc5rZ8fNL2U/qqQ3Oa/LR5aoKTP7n6k6/MKZ78/pS+6tCcHkyy6pGQ/MnVnzy35fvw9Bcnf3L1Jz+YZLv6bSmn6k+e2/JVz2LkT67+5Lkt34e3GHTyJ1d/8tyWr3qOIn9y9SfPbfk+RcbIn1z9yXNbvk+RMfInV3/yPA/qU2SM/MnVnzy35fsUvy35k6s/eW7L14qMkT+5+pPntnytyAf5k6s/eW7L16p8UE4VoPxokreiTSaAcgWoyG35GmcsCKBCASqOJnnjjAUBVChAxdEkb5yxIIAKBajIbfkaZywIoEIBKo4meeN2LAigQgEqjiZ545wGAVQoQMXRJDfOaRBAhQJUHE1yq35byGkoQEXuy2ec0yCCCiWoOJ7kxjkNIqhQgoqW/X6RMSKoUIKK3JfPiowRQYUSVBxPcisyRgQVSlBxPMmtyBgRVChBxfEk9yIfRFChBBXHk9yLfBBBhRJUHE9yL/JBBBVKUJFnRHmRDyKoUIKKlm9RPK8giKBCCSpyMVTxVhlEUKEEFXlGVPGsHYRQoQgVlm/7/O4RpFChChWWb/s8vBakUKEKFXlIVPFGGKRQoQoVzyFR/EYYxFChDBXHlPiNMAihQhEqjijVvwqlVBEqbF5/FUqpIlTkvnzxQTIJYqhQhopjSvUvSylVhgq/Td4PYqhQhgpvt2tKDBXKUJH78hVvlUEMFcpQkWdEFW+VQQwVylCRZ0QVb5VBDhXqUJFnRBVvlUEQFQpRkWdEFW+VQRAVClGRZ0QVb5VBEBUKUeH5FlX0lARRoRAVnmNSRU9JEBUKUXFUqXqrDIKoUIiKPCOqeKsMgqhQiIqjStVbZRBEhUJUROa0+G0JokIhKiLfooreliAqFKIiz4gq3iqDICoUouKoUvVWGQRRoRAVkW/7RcYIokIhKiJHpYqMEUSFQlTkIVHFW2UQRIVCVOQhUcVbZZBEhUpU9HyLKvJBEhUqUZGHRBVvlUESFSpR0fMtqmiTSaJCJSrykKjqrZIkKlSioudbVJExkqhQiYo8JKp6qySJCpWo6Pm2X2SMJCpUoiIPiareKkmiQiUq8pCo6q2SJCpUoiIPiareKsmiQi0qcjFU9VZJFhVqUTHyLarIKVlUqEVFHhJVvVWSRYVaVOQhUdVbJVlUqEVFHhJVvVWSRYVaVOQhUdVbJVlUqEVFHhJVvVWSRYVaVOQhUdVbJVlUqEVFHhJVvVWSRYVaVOQhUdVbJVlUqEVFHhJVvVWSRYVaVKRFVW+VpFGhGhXzNgElSKNCNSpmLtornrVJo0I1Kg4tle8vpFGhGhW5MV/1/kIaFapRcWipN542H6RRoRoV8yb7QRoVqlExb7IfpFGhGhWrlv0giwq1qDiwVG3tF2RRoRYVuS1fMe8jyKJCLSoOLPXGWx0GWVSoRcWBpfKXJYsKtahYN9kPsqhQi4rclq+8ppRStajIbfnKa0opVYuKA0v1NaWUqkVFroWq3pDJokItKvZN9oMsKtSiYt9kP8iiQi0qdi37QRIVKlGRm/IVG5QGSVSoRMW+Td4PkqhQiYrDSr3xIoIgiQqVqDis1IuNMIMkKlSiYmdbynPNgyQqVKJiZ0p5oW2QRIVKVBxW6o0nagZJVKhE9cNKvfEky04S1VWi+mGl3ri/7iRRXSWq51Ko4o7rJFFdJap/bn1+J4nqKlH9k60pr3LrJFFdJao/m/Jx1jtJVFeJ6p9xyXonieoqUf2wUjdeIN9JorpKVM+lUEXWO0lUV4nqn33JeieJ6ipRvX0uWe8kUV0lqrd2yzpJVFeJ6oeVyqyTRHWVqJ6b8m1+Vu8kUV0lqucRUUXv0kmiukpUf46I4t6lk0R1lah+WIl7l04O1dWheh4Q9Z2vFf/NeNVBKVWH6geV7Nvn0x1HDtXVoXouhSp/FUqpOlS323YSnRyqq0P13JSvuh7kUF0dqqdDFdukdnKorg7VDyr1YsleJ4fq6lDdriklh+rqUN2uKSWJ6ipR3S4pJYfq6lA9Hcr4uaGTQ3V1qJ6LoSy+T7dzv+qglKpD9VwOVRwi1MmhujpUP6hU/rLkUF0dqueefFXSyaG6OlT3TCnvFtDJobo6VHe/XVNyqK4O1Z/zoYprSg7V1aH6QaVuRf9EDtXVobrfFu11cqiuDtX9tmivk0N1daju9aK9TgrVVaF67sjHqyA7IVRXhOrxuV1QQqiuCNXjGlJCqK4I1Z/VUPxVyKC6GlSPzGjx3EEG1dWgelxbUjKorgbV49qSkkF1Nagel5aUBKqrQPUUqBG4mqGTQHUVqJ7b8RVjDZ0EqqtA9cNJ9a9CIVWB6v3a35NAdRWongJVXQ8SqK4C1fNoqOp6kEB1Faiea6GseLIlgeoqUL1fU0oC1VWger+mlASqq0D1fkkp+VNXf+r9+lRK/tTVn3q/9vfkT139qfd9/VUopepPfVxTSv7U1Z/6uD6Vkj919aeea6Gq60H+1NWf+siU8jycTv7U1Z/6uKaU/KmrP/VxTSn5U1d/6uOSUtKnrvrUcyWU89hvJ33qqk99XPbk6YRPXfGpj339USikik/9uhNfJ3zqik/9SFJ5OQifuuJTn5cNeDvZU1d76geSerFFfCd76mpPfV4zSvbU1Z76vGaU7KmrPfV5ySjJU1d56ilPX5mE/c06yVNXeeqHkeorSiFVeerzNs+0kzx1laee8lR9F7KnrvbUV4aUV2J2sqeu9tTX7WiITvbU1Z76uh0N0cmeutpTX/XREJ3kqas89cNI9RWljKo89cNI9RWllKo89dyFr0oHyVNXeeopT+V3oZSqPPXDSP9eL4vvQilVeepXeeokT13lqV/lqZM8dZWnfpGnTvLUVZ76I0/Fcy3JU1d56oeRyitK8tRVnvq++WgneeoqT32P63ehlKo89ZSn4oCKTvLUVZ76vil+J3nqKk993xS/kzx1lafxqRV/kDsNdaeR7lQctTHInYa608gVUIO3zxvkTkPdaaQ78RDBIHYayk4j2an4YQex01B2Gp9bSAex01B2GslOxckjg9hpKDuNXABVXlII6VB2Gp91u6SQ0aHqNFKdnN+cBqnTUHUa7daSDlKnoeo02q0lHaROQ9VptLolHWROQ81ptHwm5Uf0QeY01JxGHgRV7FQ7yJyGmtM4gNSj4VyCQeY01JxGmlPxHjlInYaq0ziE1Ivdbgep01B1Grn6qUoYqdNQdRrX1U+D1GmoOo3cgK/6bUmdhqrTyNVP1W9L6jRUnUaqU/XbkjoNVadht/H8Qeo0VJ2Gxe23JXUaqk4jVz8VhzEMUqeh6jSum/ANcqeh7jSum/ANcqeh7jQum/ANUqeh6jRy9VNEcUUppapOI9Upim6B1GmoOg3PlBY9PqnTUHUaqU7VL0vqNFSdht9mmgxSp6HqNDxu15TUaag6jVSn8ppSSlWdxiGk+ppSSlWdhmdrWjw2kDoNVafht+fSQe401J2G355LB8HTUHgacXkuJXYayk4j1z7t4mGO2GkoO42DSF5swjfInYa608i1T5vnVA1yp6HuNCJuvyy501B3GnF9MCV3GupOI90p+BCFQfI0VJ5GZEp5btcgeRoqTyPXPpXXlFKq8jRSnjoPUw6Sp6HyNPr1yZTkaag8jX59MiV5GipPo1+eTMmdhrrTSHcqRk0GudNQdxoHkcorSu401J1Gv6aU3GmoO410p/K7UEpVnkbuwdd5rHOQPA2Vp3Hdg2+QPA2Vp3Hdg2+QPA2Vp3HZg2+QOw11p3EQyYrTDwa501B3GulO3XBG+CB3GupOI92p85zOQe401J1G7sFX/bLkTkPdaVz34BvkTkPdaRxGqq8ppVTlaaQ8ldeUUqryNHIPvvKaUkqVnkbSU+fRvUH0NJSexnUPvkH0NJSexnUPvkH0NJSexmUPvkHyNFSeRspTL548SJ6GytPIPfg6n50ySJ6GytPIVU+9eGogeRoqTyPlqTgecJA9DbWnkfbUN6eU7GmoPY20p8GzqAfZ01B7GgeS+uBVxoPsaag9jbSnwfNTB9nTUHsaaU+jePchexpqT+NAUi+O1BtkT0PtaeS6p1HklOxpqD2NtKdRPCGTPg3Vp5H6NCb316RPQ/VpPOueeHfWQfo0VJ/GoaQ+ipEk0qeh+jRSn6qWkPRpqD6NdR2NIn0aqk/jUFLZBpE+DdWnsTOnxZM66dNQfRqpT7N4JiR/GupP42BSnzyPepA/DfWnkf40i/uW/GmoP41c+VQcDzjIn4b608iVT7N4cyF/GupPI/1p8srtQf401J9Grnyq2iDyp6H+NHLl0yz6KPKnof4005+KIwYnCdRUgZopUEUbNEmgpgrU/NilDZokUFMFan5yH3PezXgSQU0lqJkEVbRBkwhqKkHNT+a0qgNyOpWg5vUQqEkENZWg5vUQqEkENZWg5uUQqEkCNVWgZgrU99BGeL6dJFBTBWqmQH3TQb8sCdRUgZqHk+xf0mnP7UkCNVWgZgpUcXjkJIOaalAzDapKBxnUVIOaeQhU0UNNMqipBjXToKrfhQxqqkHNA0r170IpVYOaB5Tq34VSqgY106DK34VyqgY1Dyj14lDPSQY11aCm3d6hJhnUVIOadnuHmmRQUw1qWv0ONUmgpgrUzP33/rXpNNN1kkBNFaiZAlVdURKoqQI17famP0mgpgrUTIEqvwulVAVq5sqn4rjWSQI1VaCm3cajJhnUVIOadhuPmmRQUw1qej0eNUmgpgrUTIEq3ignCdRUgZqPQLFPThKoqQI1PXfb550SJgnUVIGaKVDVL0sCNVWg5uGkak/DSQI1VaCmj+t3oZSqQM0UqMVPlZMEaqpAzVz3VBj4JIGaKlDTsy3lt+NJAjVVoGbcpkJPMqipBjUPKFVvHZMMaqpBzbjmlAxqqkHNuOaUDGqqQc00qMVvlJMMaqpBzWftU9ECkUFNNaiZB0FVLRAZ1FSDmmlQ3AKRQE0VqBk566R45yCBmipQMy7r8yYB1FSAmkeTyh+FAGoqQM1+W583CaCmAtRMgCpmrE0iqKkENftlAt8kgZoqUDMFahW/CgnUVIGa/ZpREqipAjX7NaMkUFMFavZLRsmfpvrTzJ33ijVtk/xpqj/NXPm0JirFJH+a6k/zcFK1n9AkgZoqUDNPgap+WRKoqQI1DyeVQSeBmipQM3feq64pCdRUgZopUNU1JYGaKlAzVz6V15RSqgI1U6Ba8QZGAjVVoOaYt7uFBGqqQM2xbncLCdRUgZopUHy3kD9N9ac5syld/NxB/jTVn2YufVq7qINSqv4005928fxDAjVVoGYK1G5FHZRSFaiZArVZ0ScJ1FSBmilQ24s6KKUqUDMF6jvXA+uglKpAzRSof10L10EpVYGaKVDffaGxDkqpCtRMgSoO05wkUFMFaqZA7WL8hgRqqkDNFKi9uQUigZoqUPNw0viOdlLrQQI1VaDm4aTxKd7QSaCmCtQ8nDQ+xs/6JFBTBWoeThrFuXyTBGqqQM11bU1JoKYK1Lyuf5okUFMFaqZAVe0YCdRUgZq5/qlqx0igpgrUTIGq2jESqKkCNVOgqnaMBGqqQM0UqKodI4GaKlAzBapqx0igpgrUTIGq2jESqKkCNVOgqnaMBGqqQM0UqKodI4GaKlAzBapqx0igpgrUTIGq2jESqKkCNVOgqnaMBGqqQK3DSVU7tkiglgrUOpxUtWOLBGqpQK1Ptqc8ZrFIoJYK1Pr4pR1bJFBLBWp9sj3lV8pFArVUoNbn9g61SKCWCtT63N6hFgnUUoFan/odapE/LfWndTip2n14kUAtFah1OGl82EkXCdRSgVrtc/tVSKCWCtRqtxf9RQK1VKDW4aTyepBALRWo1TKlk68HCdRSgVotU8qtxyKBWipQq11TSgK1VKBWu6aUBGqpQK12SSn501J/WgeTKmFY5E9L/Wm1fb2ilFL1p3XdeW+RPy31p5X+VH0X8qel/rQs21Jei7VIoJYK1LqeALVIoJYK1LqeALVIoJYK1LqcALXIn5b60zqYNBrPnVvkT0v9aaU/FXMJF/nTUn9aB5PKnpb8aak/rYNJo9hjcpE/LfWnlf5UzPVYJFBLBWodThqN3zoWCdRSgVqHk0ZxYskigVoqUOtw0mjFUwMJ1FKBWoeTRuMdABcJ1FKBWt5vdxwJ1FKBWoeTytaDBGqpQK3DSaMVfS0J1FKBWilQxZy1RQK1VKCW71vWSaCWCtQ6nFRmnQRqqUCtFKgq6yRQSwVqRea06K9JoJYK1IrMKc8jXiRQSwVqReaU5yMuEqilArUOJ41iN+ZFArVUoNbhpGHF0z4J1FKBWnEbN11kUEsNasVt3HSRQS01qBX1uOkiglpKUOt40ijOxFlEUEsJah1PMv/8r/f/ut74JFBLBWodTip/FBKopQK1+m1B6SKCWkpQ63hSfTkopEpQ63hSeTkooypQq2dGizdBEqilArX6NaNkUEsNavVrRsmglhrU6peMkkAtFag1MqM863aRQC0VqDVuO0QuEqilArVGhpTPcFgkUEsFah1OGsbjN4sEaqlArRSoYo+ARQK1VKDWyL12eY+ARQK1VKDWyFn7rFiLBGqpQK3DScP4bJ9FArVUoNbhpPJuIYFaKlBr3GbtLzKopQa1ZuaUz7FaZFBLDWrNa07JoJYa1JrXnJJBLTWoNa85JYNaalBrXnNKBrXUoNa85pQMaqlBrXnNKRnUUoNa85pTMqilBrVm5rR4yiaDWmpQ6zn7qWjVyaCWGtRan1urTga11KBWGhS36iRQSwVq5RqoYqbYIoFaKlBr3fY2WyRQSwVqpUBVvwoJ1FKBWteznxYJ1FKBWrkDX3k9KKUqUCvPfiqvB6VUBWodTmrfNS4wO3ORQC0VqLWuKSWBWipQa19TSgK1VKDWvqSU/GmpP630p8LjFvnTUn9a6U+Fxy3yp6X+tB5/KtJB/rTUn9bjT+xxi/xpqT+tx5/Y4xb501J/Wo8/scct8qel/rQef2KPW+RPS/1pPf7EHrfIn5b6084VUIXHbfKnrf60DyZVd9wmf9rqT/tzmx21yZ+2+tPOFVBF1jf501Z/2rkCqsj6Jn/a6k87V0AVWd/kT1v9aecmfEXWN/nTVn/a6U9F1jcJ1FaB2rkCqsj6JoHaKlA710AVWd8kUFsFaufZT0XWNwnUVoHaefZTlXUSqK0CtQ8njWJ76U0CtVWgdruN7W8SqK0CtdttbH+TQG0VqN3qsf1N/rTVn/Z1F75N/rTVn3a79fmbBGqrQO12Owtik0BtFaidAlW8pW8SqK0CtQ8nVW8/mwRqq0Dtw0nV288mgdoqUDsFqnj72SRQWwVqH04qk04CtVWgtt1W6m0SqK0Cte32BrXJoLYa1LbbvrubDGqrQe3cha/KGBnUVoPaaVDFG/Ymg9pqUPuAUp0xyqka1PbPLWNkUFsNaqdBVRkjg9pqUDsNqtjTfZNBbTWo7dfWlAxqq0Ftv7amZFBbDWr7pTUlgdoqUNuvKSWB2ipQ+zn7yXA96SaB2ipQ+3BS/atQSlWgdp7+VKwJ2yRQWwVqx+f2XUigtgrUPpw0nKV0k0BtFaidAlWcib5JoLYK1M7zn4q3400CtVWgdlxbUxKorQK1cw1UlTESqK0CtZ81UNXvQjlVgdqHk0axI/smgdoqUDtuK0o3CdRWgdpxW1G6yaC2GtTu9YrSTQK1VaB2z5Ty/KpNBLWVoPbxpPgw/WwiqK0EtbvffhUiqK0Etfs1pURQWwlqH1CqrwelVA1qH1CqrwelVA1qH1CyMWlR2CaC2kpQ+7oN3yaC2kpQ+7oN3yaE2opQ+7IN3yaC2kpQe2RIeXLDJoLaSlA7CcoZ8zcR1FaC2klQzpi/iaC2EtQ+njScMX8TQW0lqH08aQRj/iaC2kpQOxdBFQEjgdoqUHvcZu1vEqitArVToIL3ONokUFsFah9OGlH0tCRQWwVqp0AF73G0SaC2CtQ+nDSC5yRtEqitArVToILnJG0SqK0CtVOgij2VNwnUVoHa1xOgNgnUVoHa1xOgNgnUVoHalxOgNvnTVn/a6U/B/rTJn7b60841UMW+C5v8aas/7fSnfzdt//er2KsOSqn60z6YZP++y79n2z2lCuKnrfy0V4a0aMMIoLYC1M4DoP69oIf/9+rfyJ+2+tPOFVDBdrTJn7b6005/Kvbd3eRPW/1pH0yqZt1u8qet/rRzD76v1mIdlFL1p30wafSiHSR/2upPO/3pX0ppjvomf9rqT3vtW9tB/rTVn/a+zYbe5E9b/WnvdrtrSaC2CtROgaruWhKorQK18wyo6q4lgdoqUPtwUnXXEkBtBah9NGn0oosjgNoKUDuPgCruWvKnrf6097zdteRPW/1pH0wq71ryp63+tPMEqOquJX/a4k/2OZhU3LVP6d86fn/4U8dJacenhqf0VUfTOqy+a5/SVx2mdZzWlHfffEpfdbjWcenxn9JXHaF1XHr8p/RVR9c6yh7/KXvVMLSGMxL17xkq+muk4Sl91TG1jkwp7jX5lL7qWFrHSWlf3/HSf88UWsc7pb8/fOrIHfi+bce7/XlKtY6mKW2ZUhwvfUpfdWhKc/0TTs18Cl9VaEiPJJk3Gj5+Sl91aEgTn8aHLyng0+8Pf+rIWab+HYha738HhbRpSI8lDV4W8pS+6tCYtnm7aYGffn/4U8c5qYwHO5/SVx0a0+SnKurAT78/fOo4ljR4u+ynVOswjWkugOIBwqf0VYfGNPmp+l2An35/+FNHTuDD4Zun9FWH5vRYUnW7gD79/vCnisvMqKf0VYfGNPWpaglBn35/+FPHvMUD9On3hz91nPenD+5A/pS+6tCYWu4ahYL1lL7q0JimPlUtIejT7w9/6qjn7D+Fryo0pW63lhDw6feHP3XkprtFSgGffn/4U0fcWkLAp98f/tSRT6Y4nvWUvurQmB5LGgMfCZ/SVx0aU79M2n9KX3VoTP0yaf8pfdWhMfVy0v5T9qpBQxr5kr+5ywd8+v3hTx3tduMDPv3+8KeOk1IcIXwKX1VoSOPy9vSUvurQkB5I4teWp/BVhWY0Fz9Vtz3Q0+8Pf+o446W8Xe5T+qpDM5qLn6pHfaCn3x/+1HEW5n97fLyklNHQjB5HKtsfoKffHz51HEmyzukAe/r94U8V7db8gD39/vCnjgzp4p8F7On3hz91+K35AXv6/eFPHRd7ekpfdWhMc/lTdeODPf3+8KeOa48P9vT7w586To8/UOGf0lcdGtPEp+rOB3z6/eFPHfty54M9/f7wqWJcO3zQp98f/tRx2cD8KX3VoTEd15d80KffH/7U4bc7H/Tp94c/dcTtzgd9+v3hTx39cucDPv3+8KeKcbvzQZ9+f/hTR6YUh8Se0lcdmtLUJz4N4il91aEpHZcZ+0/pqw6N6bzM2H9KtY6pMZ3ljP2n7FWDhvRAUtn+gD39/vCnjtPj7+BRNbCn3x/+1BGXBw+gp98f/lRxevxRvFsDPf3+8KeOcQsH4NPvD3/quBDpU/qqQ0N6JKn+WSikU0Oa+FT+LBTSqSE9lFR2C6BPvz/8qaPdfhfQp98f/tRx3vH5+Kan9FWHxnRdpu49pa86NKbrMnXvKX3VoTld5dS9p+xVg6b0SFIBJU/pqw5NaeITHyTzlL7q0JSubEqLkRfAp98f/tRxRqL4EJin9FWHpnR/bukAfPr94U8dlw2jntJXHZrSbbffBfDp94c/dfjtdwF8+v3hTx1x+11An35/+FNHv/0uoE+/P/ypI1tTpKOn9FWH5nRf3/GBn35/+FPH9R0f+On3hz91XN7xAZ9+f5g1tCNJxXZiT6nU0RSfWuJTcUUb4VNTfGq5+KkYP26ET03xqX38+l0gpU3xqeXmexNnND2lrzpC6zgp5ePSntJXHV3rOCmd/FDZiJ+a8lM7ljT4uLSn9FXH1DpOazpxKtFT+qpjaR2nNZ04legpfdWhOc3t9/ios6dU61B+aslPE2fePaWvOjSnufhpsi808qem/tRy+73JI5WN/KmpP7Xcfm8VOSV/aupPrd0G9hv5U1N/am3c7jnyp6b+1NKf+Jigp/RVh+a0XeaYPqWvOjSn7TLH9Cl91aE5tXKO6VOmNag+tVz8xMfRPKWvOjSlli9QNNHjKXxVoSFNfKp+FMKnpvjUbmufntJXHRrSQ0n15aCQqj61Q0nl5aCMKj61xCc+WOcpfdWhGb0d//SUvurQjN6Of3pKX3VoRuvjn54yrUHpqeXCJz7e5yl91aEZzYVPq+gVyJ6a2lPz27B+I3tqak8tN99bRc9C9tTUnlra0yp6FrKnpvbU0p6qhJE9NbWn5re3/Eb21NSeWi59WkUPR/bU1J5abr63ih6O9KmpPrVc+lT9tqRPTfWp5dKnXfSSpE9N9anl0qddPM0RPzXlp5ab7+2iESN+aspPLW7Tohr5U1N/anGbFtXIn5r6U4t6WlQjfWqqT+1QUvnMQPrUVJ9a6hNvCPSUvurQlB5Kqn8VSqnqUzuWVL63ED815aeW/FR9F+KnpvzUcve9XTzrEz815aeW/LSLVp34qSk/tdx9bxetOvFTU35q/fpcSvzUlJ9avz6XEj815aeWS5/K34VyqvzUjiWNzSMnjfipKT+1fhvYb+RPTf2pjdvAfiN/aupPbdQD+430qak+tUNJ/+4ivqKkT031qeXaJz764Cl91aEpTX2q0kH61FSf2rhM2H9KX3VoSpOfqoQRPzXlp5b8VCWM+KkpP7Vxm73XiJ+a8lM7llR/F0qp8lObORq1cKyyET815ac2szXdOB+pEUA1BaiWALXxIPGn9FWH5nRe9jJ9Sl91aE4ToKr7hQSqqUC1FKjqfiGBaipQbV5bUxKopgLVDieV9wsJVFOBavPa65NANRWoNrPX5zHkRgLVVKDas/1e0SKTQDUVqHY4qWyRSaCaClTLDfi4RSZ/aupP7WBSsbXIU/qqQ1O6rq0p+VNTf2q5/Im32n5KX3VoSlOgql+WBKqpQLU8AKpqCUmgmgpUy+VP5XehlKpAtecAqOJtkASqqUC1FKhdvIWRQDUVqHYVqEYC1VSgWi5/qjJGAtVUoNq+ju2TQDUVqLbj9ruQQDUVqHY4aX54ilYjgWoqUC3XP1WtBwlUU4Fqj0AVrQcJVFOBarkBH7ce5E9N/akdTrKv5r830XlKX3VISu1w0uSjm55SqcNUoOxwUvWrGAmUqUDZbfu9p/RVh2kdfrkeRgJlKlB2OKm+HpBSU4GyT6aU32yNBMpUoOxzS6mRQJkKlH1uKTUSKFOBsk+dUiN/MvUny833PoHz5oz8ydSf7Nl8Dw86e0q1DvUna+32q5A/mfqTtWtKyZ9M/claztgffD3In0z9yVpcrwelVP3JWqaU+zgjfzL1J2vXlJI/mfqTtWtKyZ9M/cnaJaWkT6b6ZIeSJh8/95S+6tCUWralPPpi5E+m/mTWbr8K+ZOpP5ldU0oAZQpQdjRp8qFtT+mrDk2pZVvK4/JGAGUKUHY0qdj07il91aEptWtKSaBMBcrsmlISKFOBMruklPzJ1J8s/am8GpRS9Sc7nFTWQQJlKlDmt+dSI4EyFSg7nFT/OyilKlDmmVJ+5zASKFOBMr+N7BsJlKlAmd9G9o0EylSgzOuRfSN/MvUn8zykDDc6eEpfdWhG8/CnwUv0jPzJ1J8s1z4NXpNm5E+m/mRxm7Fv5E+m/mTP4U88B9DIn0z9yQ4mFQdIPaWvOjSlcU0p+ZOpP9lt672n9FWHpvRgUp/F70L+ZOpPlv40cZPap/RVh+b0cFKfvJTUSKBMBcpiXfNBOVWBsjz8afLYnJFAmQqU9cthek+p1qECZT37fJ7BZyRQpgJlh5PKVowEylSgrPutFSOBMhUoO5xUtGLkT6b+ZAeTmnVuxcifTP3J+rg9H5M/mfqT5fFPvOzIiJ9M+cmOJdU/LIVU+cn65Vydp/RVh4Y0+am6pMRPpvxkyU/VJSWAMgUoG/WGUU/hqwrN6MGk2YqxBvInU3+yce3xyZ9M/cnGtccnfzL1JxuXHp/0yVSf7FDSLMbUjPTJVJ9s5HZRn/91+69vbcFIn0z1yQ4l1b8KhVT1yeZlu6inVOtQfbJDSeX1IH0y1SebdrsepE+m+mQzU1qMNZA+meqT3bbee0pfdWhKb1vvPaWvOjSl9dZ7T9mrBk3pgaQeUfwqlFK1J8ut96IXdVBK1Z5s7uuvQilVe7J1TSnZk6k9WR79VF0PsidTe7Ln8KfiepA+meqTrUxpMdZA+mSqT7auKSV9MtUnW9eUkj6Z6pOtS0rJnkztyda1LSV7MrUnW9e2lOzJ1J5s7euvQilVe7Lb1ntPqdah9mT72paSPZnak+1rW0r2ZGpPtjOlvFbQyJ5M7cn2NaVkT6b2ZPuaUrInU3uyfUkpyZOpPFnKU/UoR/JkKk/2HP1UPMqRPZnak+3LonwjejKlJ096Kn5YJ3pypSf/3AainOjJlZ48d94rLqkTPbnSk+fJT8UldaInV3ryz2WHEyd5cpUnT3lqPOLhJE+u8uRXeXKSJ1d58qs8OcmTqzz5RZ6c5MlVnjzlaW5swZzkyVWePDfeK+bNOMmTqzz5YaT2HSOggJE8ucqTH0Yqf1mSJ1d58nabE+UkT67y5ClP1TUleXKVJ2+3uXtO8uQqT57yVF5TSqnKk7fs8XnunpM8ucqTX1c+OdmTqz35deWTkz252pNfVj45yZOrPHnKU+PRMCd5cpUntxyFiu+/Y72aQZInV3nylKfGo6VO8uQqT57yVP2yJE+u8uTXjfec5MlVnvwwUn1NKaUqT/7IU3VNKaUqT34gqb6mlFK1J7d8LuXBLCd7crUn99vMPSd7crUn99vMPSd7crUn93rmnpM8ucqTpzwZj3g4yZOrPPlhpGk818RJnlzlyb3ffhWSJ1d58gNJZdLJnlztyQ8k1deDUqr25AeS6utBKVV78gNJ0/gd38meXO3J45pSsidXe/K4ppTsydWePC4pJXlylSfPQ5++73DUS5I8ucqTR6YUD596Sl91aEoPI5W/CsmTqzx5XFNK8uQqT57yVF4PSqnKk8e6Xg9KqcqTR6a0ePUheXKVJ+/XlJI8ucqT92tKSZ5c5cn7JaXkTq7u5D3bUp434+ROru7kPW5XlOTJVZ78uvLJSZ5c5ckPI03jeTNO8uQqT34c6d9X5GdsoidXevLbqU9P6asOTent1Ken9FWHprQ+9ekp0xoUnjzhiQ9VfkpfdWhGDyMVhyo/pa86NKUjX/HxAL2n9FWHpnTkvD08VPkpfdWhKT2MVByq/JS+6tCUpjzxocpP6asOTemBpOJQ5af0VYemdORIFB6q/JS+6tCUHkgqDlV+Sl91aEoPJE0rntPJnlztyQ8khRd9HNmTqz35gaRpvPrbyZ5c7clz6z13nF/qZE+u9uQzW1Neu+BkT6725AeSpvPqbyd7crUnn3lWCa8mc9InV33yXPkUg1tT0idXffJDSdN5FbqTPrnqk6c+lfmgnKo++aGk6bzO2EmfXPXJDyVN55muTvrkqk+eJz8Vh6Y46ZOrPnnqkxe9PumTqz75oaTJJwI+pa86NKeHkiIWD92SPrnqkx9Mml60H+RPrv7kz9qnRttdOvGTKz/5ypgWr/nET6785MlPfDDhU/qqQ2N6LGnywYRPqdah/OTJT8ETEZ34yZWf/FjS5BMBn9JXHRrT5Cc+EfApfdWhMT2WNPlEwKf0VYfG9FhS+VBI/OTKT76vr1AEUK4A5UeTyscxAihXgPIEqOpxjADKFaA8N9+rHsdIoFwFKj6fy+NYkECFClR82uVxLEigQgUqDidVj2NBAhUqUPEIFD+OBQlUqEDFJy6PY0EEFUpQ8emXx7EgggolqPiMy+NYEEGFElR8cjMeHgIOIqhQgoojSpNP4XxKX3UsrWNfHseCECoUoaJle8rdXBBChSJU5PKn4MUYQQgVilCRCMWHRj6lrzo0p80vj2NBCBWKUNGyPeU+KgihQhEqcvlT8TgWhFChCBVHlGbnfi4IoUIRKhKh+MTHp/RVh+Y0Eap4HAtCqFCEilwAxUcLPqWvOjSnuQCqOAcviKFCGSqOKVWPY0EMFcpQcUxpFkdqBTFUKEPFMaXicSxIoUIVKlKhOpttkEKFKlQcUpq9uPVJoUIVKlKhenHrk0KFKlRYxrS49UmhQhUqUqGKM4KCFCpUoSIVahS3HClUqELFIaU5iluOFCpUoeKQ0hxF80EKFapQ4bc5+0EOFepQ4bc5+0EOFf/f2rsuya3k5tr3Mr8ndjCTefQdfNfgcFSUuktSjVpdPXXQmjUO3/vHQ+WbCRBJoZcd4e1dlpZAMglmAnhw4BzKjf2cfSdRKMcplFuQkpveimSsO4lCOU6h3IKUYpDj6k6iUI5TKLdSqO5bkbSUUyi3IKWekewkCuU4hXILUuqvh6SlnEI5N+yth0ShHKdQzq1a2tkIJQrlOIVybldLJQ7lOIdybldLJQ7lOIdybkdLJQrlOIVy6/ynsbeikpZyCuXcqqUdk1CiUI5TKOfi7luRtJRTKOd2tVSiUI5TKLd24Ouuh6SlnEI5v2pp53ySKJTjFMqt9U+d3vROolCOUyi3W//kJA7lOIdyu/VPTuJQjnMot1P/5CQK5TiFcgtS6vVLcBKFcpxCuXX8U2fOh5MolOMUyvm4+1YkLeUUyvldLZUolOMUyvm1f4TcL8FJFMpxCuXWAqjeekgcynEO5cKqpXJwzUkcynEO5cKulkocynEO5cKulkocynEO5cKOlkoUynEK5RakNBkCspsvUSjHKZQLaw7fMg0rmMhlSFrKKZRbK6BCx6aUKJTjFMqtFKrTIclJFMpxCuVWCpWi7LZIFMpxCuVWCtWZfuAkCuU4hXIrhXJyWMxJFMpxCuUWpNR1wSQK5TiFcmsFVCci7iQK5TiFciuFinI+kJMolOMUyq0UqlPz7CQK5TiFcgtS6rmCEoRyHEK5hSj1IvNOglCOQyi3QqjeBiRBKMchlFuIUq/BmpMglOMQyq0QqrekEoRyHEK5hSiNnaFaToJQjkMotxClcTKjpCF2ToJQjkMotxClMchlVE6CUI5DKLcQpXEygeT1kNSUQyi3EKWxd9hKEMpxCOUWojT29EOCUI5DKLcgpbEzTMZJFMpxCuXS7qEvUSjHKZRbkFL3eJEolOMUyj2LoGR47CQK5TiFciuF6gxxcRKFcpxCud0GfE6iUI5TKLcgpe7xIlEoxymUWylUZ5iMkyiU4xTKZb93vEgUynEK5VYK1TteJArlOIVyeQ1HdVwoiUI5TqHcgpRi7ITnJArlOIVyC1Lq7oUShXKcQvlh6B8vXoJQnkMov3bg60QavQShPIdQfiFKsQNMvAShPIdQftibp+clCOU5hPLD3jw9L0EozyGUH/rz9LyEoDxHUH7hSW6UbQ8vISjPEZRfEdQoH3JeQlCeIyi/8CQ39t6soKSeIyg/rJtp780KSuo5gvILT3Ide85LCMpzBOWN2TmwvYSgPEdQfu3AN8oHlJcQlOcIyq91UK73LJKWcgTlF57kXO8+JC3lCMqvE6C8HK30EoLyHEH5FUH1vloJQXmOoLzZm1viJQTlOYLyZj30O3oqISjPEZQ3a6uT3nuR9JQjKL/wJJfkOgQvISjPEZRfEVRn+JKXEJTnCMqvPfg6g5O8hKA8R1Dejnvfi8SgPGdQfh0CleSD0ksMynMG5ddKqNR5LxKD8pxB+QUouSQbp15iUJ4zKL8AJZd771bSU86g/MqgejomMSjPGZS3exMhvMSgPGdQftybCOElBuU5g/JjfyKElwiU5wTKj+tuKpvZXiJQnhMovxKoThTHSwTKcwLl10qo2NEOiUF5zqD8ApR6ZraXGJTnDMqvPfg6ZraXGJTnDMqvU6A6JrKXGJTnDMqvDMpZ0S31EoPynEH5lUF1zGwvMSjPGZRfGVQnAuMlBuU5g/ILUOqZtxKC8hxB+YUnOS976V5CUJ4jKL824et9+BKC8hxB+d0mfF6CUJ5DKO/2AqdeglCeQyj/LIWSPVsvQSjPIZRfIVTvk5MglOcQyru9wKmXIJTnEMq7vcCplyCU5xDKr2Ogep+cBKE8h1Dem71PToJQnkMo7/cCp16CUJ5DKL8WQ/UMKQlCeQ6h/MKUep+cRKE8p1B+rYXqfXIShfKcQvm1Fip2bGSJQnlOofzaha931koUynMK5Z+1UJ2zVqJQnlMov1Io+ayVGJTnDMovQClYLyuHxKA8Z1B+ZVA961ZiUJ4zKL9OgepMcfESg/KcQfm1C1/vzUoMynMG5cPuZipRKM8plF+QUn9NJS3lFMovSKm/ppKWcgrlw96sMi9RKM8plF+QUux5HRKF8pxC+bBrmUoUynMK5eOuZSpRKM8plI87lqnEoDxnUH4BSj0K7iUG5TmD8iuD6vlgEoPynEH5lUH13orEoDxnUD7u1ZV6iUF5zqD82oWvQ8G9BKE8h1B+hVDd9ZC0lEMov0KozmQcL0EozyGUj7taKkEozyGUT7taKkEozyGUTztaKiEozxGUX3hS7HnXEoLyHEH5tQ6qt6ISgvIcQfm0u5dKCMpzBOUXntR/FklLOYLyax1U6hgvEoLyHEH5tHviSwjKcwTl0+6JLyEozxGUTzsnvgSgPAdQPq/z9OSpSV4CUJ4DKL8CqNSJ70kAynMA5dcyqN5bkQCU5wDK573eUV4CUJ4DKJ/3JpV5CUB5DqD8OgGqF4uSAJTnAMrnVUs7ro8EoDwHUD7vaqkEoDwHUD7vaqkEoDwHUD7vaKmEnzzHT2GBSb2pSUHiT4Hzp7DApM6I9yDhp8DxU1jxU+elBAk/BY6fwrCnpEHCT4Hjp7CwpP5yCEoaOH4KC03qLoego4Hzp7CWQCXZwg4SfwqcP4VhT0eDxJ8C509h2NPRIPGnwPlTGPo6GiT6FDh9CmsBVCfyGyT6FDh9CmsBVG9FJfoUOH0Ku/OfgkSfAqdPYUFJMcsWZZDoU+D0KawFUJ3Z2UGiT4HTp7B24etph0SfAqdP4Tn/qaMdEn0KnD6FBSV1tENiT4Gzp7CApNiZvh0k9hQ4ewpr+VNXwyQt5ewprD34OrNTgsSeAmdPwa4zS+SEgiCxp8DZU1jLnzqTxIPEngJnT2EBSaHT/TdI7Clw9hTsrpZK7Clw9hR2u/AFiT0Fzp7CWv/UmYoeJPYUOHsKa/1T76uV2FPg7Cms8586s1OCxJ4CZ0/Brj1N5dkpQWJPgbOnsNY/ZTlnP0jsKXD2FBaU1NUPiT4FTp/CuOqpbMsFiT4FTp/CuJdxEiT6FDh9CuNexkmQ6FPg9CmM/YyTILGnwNlTWEBSzzoOEnsKnD2Ftf6p4y0EiT0Fzp7C2oWv+1YkLeXsKYx7Q0uCxJ4CZ0/B7XlPQWJPgbOnsNY/dbyFIMGnwOFTcKuWdgxTCT4FDp+C29VSCT4FDp+C29VSCT4FDp+C29FSCT0Fjp7COv+pE5cLEnoKHD2FhSNZl//upxW1m/uQtJSjp7B24ctyH+IgoafA0VNYONI4yrObgoSeAkdPYeFIo5PbPwQJPQWOnsLCkfwgR7GDhJ4CR09h4UipM4M3SOgpcPQUVvTU03QJPQWOnoLfi0QFiT0Fzp7CswJKjnUGiT0Fzp7CApK6Oiaxp8DZU1groHo6JrGnwNlTWEBSV8ck9hQ4ewoLSurrmKSnnD6FtQ9fT8ck+hQ4fQoLSurqmESfAqdPIax62rGjJPoUOH0KYXc3lehT4PQphN3dVKJPgdOnEHZ2U4k9Bc6eQtjdTSX2FDh7CmF3N5XYU+DsKYTd3VRiT4GzpxB2d1OJPQXOnkLc3U0l9hQ4ewpxdzeV6FPg9CnEXS2V6FPg9CnE3WCURJ8Cp09hQUndnVCiT4HTpxD9nn5I9Clw+hRi2NMPiT4FTp/CgpK6+iHRp8DpU1hQUl8/JD3l9CnEvKsfkp5y+hQWlJQ6s8SDRJ8Cp08hmb1dTOJPgfOnsPbh6+1iEn8KnD+FBSZ1djGJPgVOn8KCkvzcfkZaUYk+BU6fwjoDyg2ylkr0KXD6FBaUlDqzs4NEnwKnT2FBSb2UpiDRp8DpU1hQUl87JC3l9CmkXQ9K4k+B86ewwKTue5H4U+D8KSwwqfteJP4UOH8K2e69F4k/Bc6fwloA1XsvEn8KnD+FBSaNc+s6oft3kPhT4Pwp5N2oqcSfAudPIe9GTSX+FDh/CnknairRp8DpU1hQ0hijvKdL9Clw+hQWmDRGudlbkPhT4PwpLjBpjEmMaEWJP0XOn+JCk8bOVJooAajIAVRcaFJPO6IEoCIHUHEXQEUJQEUOoOJCk3rvJUoAKnIAFRec1HsvUSJQkROoOKy7qRxFjhKBipxAxQUn9d+LoKeRE6g4rLupTK+jRKAiJ1Bx2Ms4iRKDipxBRbOXcRIlBhU5g4qmn3ESJQIVOYGKZt1L5QhflAhU5AQqLjgpDfLspCgRqMgJVFxwUvetSAQqcgIVzV5sP0oEKnICFU3YXQ9JSzmBigtQ6q+HpKWcQUWzaqkcO4kSg4qcQUWzq6USg4qcQUW7q6USg4qcQUW7o6USgYqcQEW7aqnclSNKBCpyAhUXnNTLqYwSgYqcQMUFJyUjd9SIEoGKnEDFBSd136xEoCInUHGtfuq0XYgSgYqcQEW7l2MaJQIVOYGKC06y8xkn7ccSgYqcQMUFJ9m58a70tUgEKnICFcdh78uXCFTkBCouOCkZuYtflAhU5AQqjnu50FEiUJETqLjgpGTkxplRIlCRE6g4rnoqW8hRIlCRE6g47lmmUWJQkTOoOO5ZplFiUJEzqDj2LdMoEajICVRccFLqDAaNEoGKnEDFBSelzrzEKBGoyAlUXHBSMjInjRKBipxARbdqqUygokSgIidQccFJyXS+WolARU6gohv3NEwiUJETqLhb/hQlAhU5gYoLUOq+W4lBRc6g4gKUuu9WYlCRM6i4AKVkOieUxKAiZ1DRpd13K+kpZ1DR5d13K+kpZ1BxAUqpM3stSgwqcgYV/V40KkoMKnIGFf1eNCpKDCpyBhV9PxoVJQIVOYGKfi/LNEoEKnICFReclKycyRMlAhU5gYo+7L1ZiUBFTqDigpP6b1bSUk6g4tqDr2d7SAQqcgIVF5zUXw9JSzmBimHV0s45KRGoyAlUXHBSdweSCFTkBCo+6586+iERqMgJVFxwUnc9JAIVOYGKwe3ph0SgIidQMax62tnVJQYVOYOKaxe+3pcvMajIGVQMce/LlxhU5Awqrl345C9fIlCRE6gYVi3tnC0SgYqcQMW4aqmcKxYlAhU5gYoLTkqdGXBRIlCRE6i4Eqjem5UIVOQEKu4SqCgRqMgJVFxwUndNJQIVOYGKcdVSuf94lAhU5AQqLjgpdSZjRYlARU6gYlx3UzkDOEoEKnICFePeXL0oEajICVSMe3P1okSgIidQMfXn6kWJP0XOn+LKn5L9uwv/zw+Oy5C0lPOnmNa5enLxdpT4U+T8Ka71T51BP1EiUJETqJjc3puVCFTkBCqm3WiURKAiJ1BxwUn9NZW0lBOouBKo7ppKWsoJVFwHQXXXVNJSTqDigpPS2LE9JAIVOYGKedj7WiQCFTmBiiuB6n0tEoGKnEDFtQWf/LVI/Cly/hQXmDSmToxQ4k+R86e4wKTuikr8KXL+FPOulkr8KXL+FBeY1H8WSUs5f4oLTkqd/mhRIlCRE6iYd/dSiUBFTqBi3t1LJQIVOYFKQ38vTRJ/Spw/pQUmmc5M4CTxp8T5U1pgku00j0gSf0qcP6V1CJS34ptNEn9KnD+ldQhUZ9BYkvhT4vwpLTCppx1J4k+J86c07A0rSxJ/Spw/pbUCqvteBC1NnD+lBSb134ugpYnzp7RWQHXfi6ClifOntMCk7nuR+FPi/CktOCl1hh4liUAlTqCS2ethniQClTiBSmavh3mSCFTiBCqZfg/zJPGnxPlTMquWyjZ2kvhT4vwpPSugrJihlST+lDh/Sit/6r4VSUs5f0pmz8tPEn9KnD+lJ3/qPYukpZw/pQUmpc500STxp8T5U7Krlso+WJIIVOIEKi04qWeJJYlAJU6gkt3zn5JEoBInUGklUD0dkwhU4gQqWb/3XiQClTiBSgtOCqazE0oEKnEClexePWmSCFTiBCrZvXrSJBGoxAlUsv160iTxp8T5UxpXLZWpcZL4U+L8Ka38qdMRNUn8KXH+lBaYlDpt4ZPEnxLnT2kc996sxJ8S509p3IvsJ4k/Jc6f0uh311TSUs6f0gKT+msqaSnnT2mMu2sqaSknUGklUJ0us0kiUIkTqDTu0fwkEajECVRyezQ/SQQqcQKVXJ/mJ4k/Jc6f0joBalrRcdIwF7kMSUs5f0pupfly1DVJ/Clx/pTcmnMi+y1J4k+J86e08qfem5X4U+L8Kbk9mp8k/pQ4f0puL+ckSfwpcf6UFpg03YD85Uv8KXH+lNYaqCTXGyeJPyXOn9JaA5U6O5DEnxLnT2mBSWOSa2OTxJ8S50/Jrxl8cm1skvhT4vwp+dXPl4c5JIlAJU6gkl/zTDvvViJQiROotOCkXjZikghU4gQq+V0PSiJQiROotPbf6337EoFKnEAln/a+fYlAJU6g0kqget+LRKASJ1BpJVBOjr8kiUAlTqBS2OOkSSJQiROoFPY4aZIIVOIEKoU+J00Sf0qcP6WVP7mOjy7xp8T5U1r5U3dFJS3l/CmFXS2V+FPi/CktMKn/LJKWcv6UFpyUXMcLkwhU4gQq7fbfSxKBSpxApd3+e0kiUIkTqLTTfy9J/Clx/pTWGVDZSy1Ek4SfEsdPaWFJ3QWV8FPi+CnFXcNUwk+J46e0tt/rPYqko5w+pZU+uY4XJ9GnxOlTirvek0SfEqdPKe56TxJ9Spw+pbjjPUnsKXH2lNbee9NquPT/Bt7xO0n0KXH6lFb65Jx8Jkj0KXH6lNbqJzedK17w8SX6lDh9SgtKMjbKtpxEnxKnT2lBSWZu9yTUyCSJPiVOn9Ja/zTZP356Fq7nEnxKHD6lFT6Nw9/d+P82lovEnhJnT2ntvedz561IOsrZU1p7702nvTS1IEnsKXH2lBaQZHyaZeS40TBJSzl7Smv3PduxGCT2lDh7SgtIsjaJdRRJYk+Js6e0oCRrc+c+JC3l9CktKMl08lSTRJ8Sp09pQUkmWPm9SPQpcfqUFpRkJxWTtFSCT4nDp7SQJDuazm1IasrhU1qb74VBVg8JPiUOn9JCkiYd77wWSU05fEoLSbLjOAcZ0/ZZJDXl8CkPw87RkiX8lDl+ysPaYl92SLOEnzLHT3nFT51nyRJ+yhw/5YUl2dFL6pEl+pQ5fcpr+70xyCIEJc0cPuW1+94YZRGCkmbOnvIue8oSe8qcPeV1+lOnj06W2FPm7Cmv3fc6p2SW2FPm7CmvtU+dUzJL7Clz9pTX2qfOKZkl9pQ5e8oLSHJZrvPLEnvKnD3ltf9elqM3WWJPmbOnvLIn+ZjMEnrKHD3lhST1jskswafM4VM2a5MTuYwiS/Apc/iUzdo+Qg4AZQk+ZQ6f8gqfnAxssgSfModPeSFJvWMyS/Apc/iUF5KUnAx9sgSfModPeS1+6hyTWYJPmcOnvJCk3jGZJfiUOXzK1vaPySyxp8zZU16rnzrHZJbYU+bsKdu1e4Qc28sSe8qcPeW1+snJuYxZYk+Zs6dsw97RIrGnzNlTtquadnZTiT1lzp6y3cs3yRJ7ypw9ZbuXb5Il+pQ5fcpjP98kS+wpc/aU18lPnb4xWWJPmbOnPK6EVLbTs8SeMmdPeQFJvV4aWWJPmbOnvNY+9d6sxJ4yZ0953MuKyhJ7ypw95XGvw36W2FPm7CmvtU+9TV1iT5mzp7yApP6aSlrK2VNeq5+czMCyxJ4yZ0/Z7eXuZYk9Zc6estvL3csSfcqcPmXXz93LEnvKnD3lBSQFK7OFLLGnzNlTXkBSbxZflthT5uwpu71pJVliT5mzp7yApGDlyv4ssafM2VNeQFKvL0iW2FPm7Cnvjn7KEnvKnD3lBSR1j2uJPWXOnrJfp+rI3RKyxJ4yZ095AUndr0ViT5mzp+z3OkNniT1lzp6yX/W0YyFL7Clz9pT9rp5K7Clz9pT9rp5K7Clz9pT9rp5K7Clz9pT9rp5K7Clz9pT9rp5K7Clz9pT9rp5K7Clz9pTDrp5K7Clz9pTX/ntOrlnMEnvKnD3ltf+elyvis8SeMmdPeYc9ZYk9Zc6e8sqevFy7nSX2lDl7yit78nI9WZbYU+bsKS8gKXm5c3iW2FPm7Cmv7Ml3HCiJPWXOnvLKnnzH+ZHYU+bsKa/VT75jqUvsKXP2lBeQFDv5slliT5mzp7yyp7kztGQDSfQpc/qU1+onL1cMZQk/ZY6fctzRUgk+ZQ6f8jr7KfRWQ9JSDp/yWvvk5bqlLNGnzOlTXumT73z3En3KnD7ltfYpdL57iT5lTp9y7FfoZYk9Zc6e8oKSUuh89xJ9ypw+5bXyqZNLnSX6VP7wv/7+t/P7r9P1fnr9/95fT//623/853/+7XC8348v3+f/8va3v//33w7n9a98Sn9fLvm3//jvv5m5yO8//vt//j79Sun5aw7Tr7/mMObyy47Thvv8leP8a/r5vLn1z8tdLX833+bh5fL+9e38wq+eydUNrp5x9RFXd7i6xdWT7uqvp7fTtB7k2nkg1y5POZfmlGs7XNvj2liDnD917c4KZEPuYsRdGNyFx10E3EVZCzcMurs4s4e35LIOl7W4bMBlIy7rcVmju+zb5eX4drid/kmvPpKre1x9xNUjrp5w9YCrW+3Vv307XdtLt6utk3E9/aL37si9B9y7w70n3HvGvUfc+6i+7vl2vrwzdfHk6hFX97h6+XTm2HS5esLVnfrqt+miXy/06oFcPeHqVVcGXB1bRMi4uldd/fjycvq4t1e2tll1l54Xcanoi7H45ct7MEH3ho8v9/OvE3lO177jebLEKnGeh7A+iS0rb236zFXux9uP9kpuMpXrlWxZM2OdbnNZpJ7vf96vx5cfp+ml8f3dkU9tLPuYGY1u3zi+/jy/twLnBMgqcCh6bYZUVmTOelSLJjc7twNsZPuy7kPRtKU34/orKjX5+PZ2mP6QXMd4sv+UTU2rnZPE98vriYiMQ/NpWGt1H/kkar63fz5O1/Ppdj3dHm93+vZaRRxNWezR6jbARv6fVG77IY8WWuE+JXd7w34g6uZxw0H9toSlde3SGuWX8fZ2+ePwcj29Tn96Pr7RbdS1Vs88ukEtsiNxJBvzgONrHrShlv11+t9fpg+Z7HyheVVxeB7Pc9+09Yd/7oUwHWK59lwtpLv0x/fjl9P9PJ3Ub39OZsrP0+1w/HqnB2eIjblkjfbrez++/Xk7k6UKybaSbDknjFV+f7PMf9O7s+2HkooVm2DX4AwyIz53U05Ka2HYhnJ+LePuPnM3s3V3/va4Hu/TmU0/idbGdbYYWM4qFfnjfPhxIp/v9PabFRy9Un0/zhs5nshRblqLHOnjN61F7WCcuKRcyo+PyT5eFvDwjxtdxcklaG7VPd+hKwbW8xLLqV8W+Lmxf+qyl5f76X643a+n409y+WTayz8PIWdsubzH5fEr6nyT4/X45fxClTm0yozNGc/oRq3o6f88H9+p8NgKDxDuIVyplzd60+3+MDcfXTcjV7an4rHAsUxl8ebaJtUF7/fD6f3l8np+/7YxTV37WNM5Vgy1p/OiEf50j4nU9ugxZixGpoN/6pWuSJW/iCMnR3sWmQGGLIxBgz1jOqo/eTVq9xC71sPZKrtfMZ1t2UBtMbfG4nqO5vnfjOWmRve8z+c+NP0ofvyYnn/iiuHsihq44t/6sv/74t75cj+hvMWAfXwo9zHZ+VDdsfgcY9kXlizaogDKb+V+L8rFdWvOAW6WDR5yiUJ4nB7lQCkny1hc59H4smxjWbayfsVIGksIYiymtBvLPleiDq4EJ7wtP8qG48v9zDO1nss2Ytkilq3akBmLpTTY7/fb4XZ+f6HOUnuITEql1tCbIIoutPLTfdy/k1PNxPZUg30xWuU+M8mbLbzpSCB3l1qvYYmQf1YaCcGk1qVdWnQ9v72oPC2r4Pnkev1ChbdrELUnIRX5/fj++na63qjgRAR/ehEmwfxWPZGo1EUiUb7TQOQqjWEi9/7nB1MBT1RAubVMMmdJk2n9ePn++uVwO91uzEqcWVUrWfkVPe6Xx8crU1RPzsK5qdb6xUdlrPb463h+O355I0LD2EYMs9Kt+XK8Udsm2vY5xxHR1FF3b5PAyZulBk1qDRpsb+XsmQ49nUp9Od5fvlObs9Wgcsw9QzPTNj2WYw7bdDm8nSk/bDnvbLEZi8Pm/PNf5WJM5BJ8zXAfh6EYAYOtv3AGlsN4+oUN3uFvy41OfwlTIuqMuy9vl5cf1HYge7NFsKfc4NJSRiX6cvnx83ilTq5rfKRQnNxQzspY1jWW685dWdcfxTSIxVRJxTDJ5YjMZUnsUMxRO3hEfcqxa5swkyvPF4qZsYwTe/5SbqfTk76dqPUd2nCcfdoSvxd0Pf77/LYx5HOr9yUWOwLcOGUw58vj7dvxyqSPw9BKh/ec4NRpd4DH24/Dt8mpmg2snx8sOhktUapPiuRxPRepjqqf/8cmQtjyEQss4U39pfyQJuHTrYoP3x6lxhqlUq0CN49uMxGmO5efwpb4IP6SGGSWGGR4+lG5pa7yhVBBezhP4orz6bV7dStYvvP2DPQOd64MrJMLnKeXR4W3b87DkfJeKZxGYdoPeZnfWrYebDjgN0FpcL0IkcTJ9m8dTa2gyUZ/oyc4Ma/hKrpBK/Hj+DIji+/Xy+Pb94/Hffa3rj+3gTOi0j5glYNulXcv9PK4XrnKjC0c9HCevDKQs3u9+/E6qRO9HHF2isM6/dKu4/34xjft5glSgluMaIVzuhDfy/FxO70eqJ4GovUIsppcTJslT08vnktvYxNzR4KndAOnWnvzkzfwjRrEI4l71OBN1rlaq0RKEMZWOQPOhWB1G9hT5HSEvZ/oEebIEfaZR74dPk7vcwCDCvREYAnxeKPU6lX05j7HgZw3OtvvKezrZaYdNII/p0E1J67y7H4KlJ6bfM3WFB312m1qlSwcXSOJd1TSowQGRPDmZBkJmBpAntVv6/Ty4+Nyfr9PEu+n66/jG1WGQJShpnNo318RP+0Ot8vj+nLiuR2OMFxbAsxWazC1l1ivwC9A9k1bjPzpxX72GcQVIm6uxeYzKm3Tl+/n9+mO6a5s21257PMjMnyc05l+L//4QeWOrVwLuQPkKjXy7XhjbvrYBr4T0ixGuBlOGed7ebs8Xo/0oB2JFg6+yBxKcNgMcDiGAj2WkYrrr6gE9eXav0x79WbfKgulzIV4eXvcGBX1bUDI1IBryJ8SKeUTtNuhtdo3uYgTpHkiTXlz0zZ9vF+uh1+n6yYTKZj2JSZl+KaIlCW2R0pSRmvnvz3fl/2I7hOxJfI2fFrcGlfbpK4Fcu5n5a5QpG7usQ0HqDf5Im29RX6HPhCVVGrO5edkvd4P18f7OztJfUv2TKgZgkoK+RS9fUM+GiJYaesUcZvnJken1lFapUmP3RokJgDDJiWWmCVvkk7H0N5kDUc5rdH/zDJgUemWJOSgvb+nqNt0CJ4piDEDScTSC9zkt84V+a0fXhYRZmgxQcAMi6s+lnNhLLsqQltuLFyxwC9XtNKX6J8v4TpfrhUKHcS7jCWlOBYXJha6h6TUWI6dZCtNQ7BtxGleY4xIl0Wg1g4IHg+IJ+LEts80Uc0Cv59eFjRzP/88XR7kVI3tSk8WnfbjLDIlkQT2jFqbfNrX70eeh0h2Jevhm4Jyj8hFcAC6EYGhPJbTf4Apb0qg2JoizxqESgwSEl2E5YA3Eot2LQ2in7/wDrMyvXl51OvjZTrRyNZRH7XcP6L3FjH7saqRxXJY/Bk8YHBh45CohxRYA803viRdGA9C4Mciz4MLeJBzIHfjsfj4XCbXpkhGVtTkh+DPcKfB4W/BxgPuPtTEejxvREJDrK+6hNxNBKIGFDUJADuBdCSsRgLpSMgZrYZ2gqGdTVUn/IIq5hpziPVjxq+qgBEfcwJEgHFq4JCYEb+gWAaFEzV9wCCn1SLXvfqrFtEVW3Y9WxM1LHLiq6dlE36VvGw71ix63N84oozC4ZfHr4CzCVnPDmk1DneAjI7pmy6r4cu2aH15H9Zj1RDqsojEWI/1g887mUOIf5a3ZbGHTw+OX6nmX5R/EZF9HsH/44i/RcZGxHYRyxdlUQOxTMAom0R5ylTTJrCpJxSFJDwlmMnS1+D5C+uc8S9yrL/UW/Z9+r8PHE5PHnZ71GrDEau0JlR5O/+bxbpI/kvAZxe0PuB6CX6/JtIDC0q2/nCFLDrsG6ZoojGIPhrkBjm1ATk/7uPyoIYKCSs4bGSopig/bN3KUQQAE8U69Vk+OUCduLcjhueIAJPWnV+zDIiFaEiuyQil10YenokLcybD4fL+RiK3ieRnR218bRU5S+QCx0iMZGzLQ/1ElVVPz4s88y2a3A56XqcWPy/VxP9L4ZePO/duU2sALTWpymvQ2Ikh2VbYWaodbbFvW+yGozJJcbkaTWsfG13MZVvPlUw57NYwqAJSmULUeg6/TlfmfgXyFWTkdeRcT1+czVn5fNfj7Tu7zhiIq4NT/pnSq5B5msMEW74THc0eUWpsK+7wcbwef9JITrssk1Slqi5SaQUgqeOpZ6NJSs1cRF5P/3ycblRDSb67djtcpAmL2DLAaZtV7oCNNGEJR5KCpEzmEIFhGxiBw2m8Nla8ivw9CPUkAANjN3jlcuxcp/4hvSKJzMAgD8oynpd/n2gq1dgGIBNcjBEuhlPW4Lwe3883JrrNlkca+4ikDed0u9Dr8X6kKRUENAy4aXhwDjWfXhmSnq/x5XhjKI0gP/hGFulIrtbdVosZ1rtXHuLl2odnzItpmQvEQw+fE9pVXVJJCWsqJJ2tK4iXovDEYIgocoxGZxEKV/mYznBWqk4KtQsYmnxZ3SdBDTJDOF91fRE6QnkpTvNiYSKEAScL5hycN3g1iLOV0JnN1QVZf4xFscfi28NFRDRiLJcYi+eEkuKxeF9jcWNdiUO4Yim7cquuOMKuWAuulOu4ou2uxG188f98WR9k2sCtRFaIL7YhgGwoLnQoZzrUDygpIsOwXAI9CFBRncqrTiUyiTgRog25PDI8vFzWJ9ckfGyjQ61ngF1jkOlpQH0RSzCw9KZf+NviKZlak2BwCCG+MP1CRmiqvit8XK/cHb8ceOWKJ9l7AZthhGNstVvTlyduocZnIjWV2DyG+hjKBMrXL0tlNP2eSQcEi09w1H7Pm+XwBA3V2nwEiTPwKVJ9p+9au/6rv7jNR0ikKB8h9qh0Y16/CEvvydJHaFpU1na/Tn9CklVbB9SVDxvFkK4cZq58h658Wq7sXL58z75kyPnyrIgehfLBhKKCoXzPqfwrpBblchu5fNi5qFhGmgzKCa1RGp+vp68047c12A3iPtrqxEnccXrjB6nqNbTNW6xR8rgi8ev59PZKxWUiTme6F3FPjLTZJRojSnkaM4GPK8nQaBNzPyNPXkBHnlj5xawChfXzRJr29mZKKNcfJlKr+ZfEyTSmze422lxQLnrrWo1tKut0kGkVctucxxGXBxZ3QPANQSxTU18STjptruDz0oJVTtIbPrM+Rdh2daaPv9UP7ee1CBXhqm0zgFDzOpatcyy7GBJAHYKJg9Ixf17+dDt/e5fyrNv4kPYkE0SKWmrbd+CU2F2Svn0Vts2Fdsp8mKdoaRUabVWmxlNh8vO36byj1i4hcgUlbD/R8VOLukogObtN1c5ndrvl38vP3BZeJGW4oREqvOq2w1byn9mSluZV0vtuRSpTgASJna25jUca95fvd7sSro2UTKI/s0VeT2iSIC1I6wko0wS6csVlGUn+wKCM/3evIRxdbSZfViaGT9sMa4LQKEYs9iX8oVjiOOhvl0riuDaBbr7iNtnZkGoXtCnwAOToeYJsWSRCFMu7kGRXAmco9/HFl/VFTigecKgNJIoJb0YUzyFx1GZl+Pt1zkY6H9/O/6aHMUGb8Iot0u5RaD/ZcKhVg0+HE9GgNYFBZaZBeohBUwLjkSnggTs9Dk/v8GdYYtThG49UMXQyML5KBkgMSH0JuFPEKkzw+FvcfagNEvG8sVpE6FMWkesRkesB0m0SeigkZIwkrAb8JJN8tbBqS8Ral1H+RQaVzQhNZ9xzru21kB8wIGI1oHyoJvoOyIcwSL82oO4GGQAGpMsgo8DkGjjDL+QRWJStWmQU1O4NFlHWmhhv8eXYEg+yY+2HWNPDazAOwY/R11+gSih4dg6/cAdo82A9ml16MD4Pwuaxagh7Tb/wt1i/gKyPUN60rT3s0F7DBuRwBGSlBOSORGwaEdHIiFwUZMzZiALZWBOuQOuQR2ex5y0zz5+/gP8THG5UGFlUty5TJp6/lPWnqyVIw0rkKEEmwZBxPWUd0yr7IB2IjoSkrbLsum9n23YHdPhGERaevm986cpcUnqxTgA/tOBm2jqwTeg39OYiAhefdLS9gKkX+CtL9ut8+mNrphIiifpwk0ZtCIZf4vbz+HE9vT5o1uzknLbXwSasjlKevzGW6k0bpHRo8qktYno9X08b0BNIEwsks07eBjLctG7B+fbjsKpNqRGg8WGSN5SVqz0LvTEDILYWt0W5nQ2fuNP1RqX7DCTYoEzDmkVub3Mgt4lmclplplHTeShAGwVB4lVVYZTMoNfdtIfjF3a0DJssa+P9l5fDJvvEk+rEekRYJDg+00JV4ifrXLoEqaip53ltyaBsnDdfgnY9niy9dlPG2YmuStZrMfQim2VmkA51RvnNT4L+uJ7vp8PX4/ltzsYnN5xIlWVNnNRGLC4v2wUORKlwVFeMqK1hnf5geoXCBQgWwipb5NYEZWfK6Q/oCzSBpIOAV6IjS/lRyAD6PqJ53ljsEMCYXGyejP11wDmHbHMzoIcA8s6NMcByMMMNcI9BYjSMVlO7riFTfbJy4dAUM9zCHZsMQKUxMi/W9D190E6vpCrGag2bRdbtcqU2DamIsdpTbZbFUi1JR8yyDDDyRmXtzuumaQepgylt1YrbMZZTAy3BDBCz8fXPgGk9krUH5HeiMnEy29GOPKi/l9vhejrSPYnkFdjaVE7/jdyWHeR+oukchG/a2uNP2Tr4denvy+51JCkiyETw2mAyegZfL39Qy6m1FBKc1qTssEUE/zq+PZhdRuw/QNik7Es6S5dWeCSfA3xLrzWNBTPftAcsNkyH+ouaj5zQ50dbrFL+QNgjyLGozCorf7Al0oHkxWWUjGRlV+wqWeiA70yrKs/elZ8XeT/eaf53IP0CMqJZWUtVn39w+368vvIOkoGkeMEYM9qGGdMfLEaCaCOQfgS2hKumj1J549fz3M37D+ojt/lJWIysjZ4/7jz9rwWZoHQjUkacMs59+jmtAJXcdn9Dd6qxxvSUx+fcnunPw+30duLVXKEN6lqjzPRb5F2+/GMSRyOZJAavs8VP73M3vsNcM0DdA5JwokxzXIVxWSPpCI8Q3CRVd1ysUslpEVt8ZS1qaayyMmVpx3p6Pbyd3r/RDp/eksRbZX3qU54gjmwpLuusj9ItlkpyRBIsCeW3eHp/5b2+fbuKBvl3k4+OmJgSTz+FH7Z+UXLEcFJr5Su7V+NJPkqxnhDRQ4ofoEMxxn0x4X1xYxExR1FhqC0uavwY1WJJmbe+3vXGs7AtQfFFVxF8DWXda7FZUrZ4OM0NhWmiWCBxERQqBuU0o0ni2yYJum0GCNNghEfjlH3PTtcr3f3mIYttfQTqRHGIeZAKFNWaiG5dqRjRBrVxBp0ZTY3numr5murmgh/Vht5K82R5kG14IbYxKeuU8HYRtpVFvFGnrLtfZ7QsnW2oU0S2DoR1wUeU2vavl7fH69K76/C48REOZPCCMoZ4+tfp5bEUnc9GE7WZ2lCCRX6rHZQNpavoufj8QIFsIMEvba9diNzcrG0LfZAjDmiGmlCMdEL1Z4VjKHwyGf75gFTaQZkhiHucn5o9NPGwtJVop3+db+zNkJ6CRrtV/et85220SLTIKg3A078+3o7nd8E1cOT5kBudtbt3K/jn9Xj9Rh+bdMIYMNZj0B5prfjLB9f2NriLnXDSe6WF+a+5NQ9tN+VJe4yALO9a8VyrQJ6xgd9eZ3YSeNcRUpJVOxkrcwq/Ht9ocpxt1dQXZuPRr798HIgQo14ilp0NtBCIMJX4dkKgMCtNxa+nyZ1jflEypK84ZEZliLfIPHx9O35jktuPKyrt7iJPEEcalSs7oH490XdsSHdGIHmHsFY5uGseAJIldR/1ku96+Hm+/eSNsgM5VLX9YhZ5rFkMGSBT+5Y/NaUkLqBrBLLdMQkP/ahrdwi03jYO2SoZ/mHO2CRA5NGSzCKXxiKYawNyArTtn76e39h8OZJcioBxUE5CmeSxCihDJOKUQguUEZVFTlkTtV6DDR8kZVZIColqBXp/FY4EkhU7oHRpUEaBJ6mbksC2k1hCu88RYwqdsoxhbVRJF4F00XVwlLUx0K/XyXFkd9smKIIFjPAenVeq2R80HZ14Y4MS6nw7vp1feDPwFkPXdio1LOmURvm34/XL8dscyXib4ywbW4OErJXNlL+drj/57baNEVFiigK16XZ1J+ncuBtjG4kWtF+CUvupMCE705DET2UGYpG6NwOytQWVQ2t7YqXbJuOLlMGTWf7b2+sXtv23X9bn5AiJzqShrPLrXFu1S5UYJMz4eVlSNm5rWRtlhsAkVN1Au/V3/k+EC4tMUl6UpbDzZfrtT9qSHCWg2QqUSlPazWVQ9oqZJSur9A15n0om8xv5gtaQNtnakaXzwID9Qm2y+ai1RSqcFspeyPxO9dYrFiaSHqHKE60RJeaWG9LzV2l/t1Kl74IOWFWL7BfaNBuQEklt5HXefWt1f+Lpe6KFEox2l3DKBKTNJaQqnkZrnbLwZh2esV3fttZG/fGWPzvefp7/xZzuRqk+oQBUoPDMLUob9YZMFXw9vfFmMG3vKyUvk0RKd9uqrTJCSkRvZ3G2gVJlUZQgUbrXtjJKGWxpJEsSWx1QVng0EheWfOMwuSV1enNrK1Oy5ciEEL2ds/z7U+9Eb+NmylQZUaawwG0To6RElZPsfmFX88KUTaW4uE5VFymM1a/Cb0u6iPWtdBQnuT9PP79M7v3380fXnCH2knotRMGSHUOyFpQho7Wf0/08y+wdZu2R8L+SKqiba9bEK2PhyxSh/eK5RomVAz9koVJVG+luNqil316+n14fb6frK0uya9NzlS0MuDi5wI84/4P+FCKihRUgyd2DMj2Zyd2+snYou3oP3ogUbpc0Wx/0Wxpk/+NCOg21dSjKzHYmTbpJ8q6UaJmJpVrV+qrqr5aIk26TeGTKXjSz3NPx+vJdSvBve2QpB8Bu5Ak36siRrn/+Re4m2axZy78iS7q/tguksr53kTk5t+c77RbahhI/LUm4t0TYln7/nNuLzF0nZZOlWcK/LFByC0k+/ycef+kx2ovzNCugLDQTZUpfUJupMui9jWplCvfbDuZQFgVJIiX7lYxrV3bwnGQLve8NKXzTx1kefYOKrKVaTx+/M6RITrY+zvl4sLT8Nkr8KSGSnpMolVLc9XSiA47a15nQzxEVHMYpyfu36+XxQQMSzanoCzJE2/JQsGItpQL1sFk5pWW56OHt9IuOT0xkTEPWhn1nYZuGQ2NbSJELqsxacDLL3NyfbZPlfal0QbfJUAreKwVNWkdpud7555nGXdroE0rJs9ZDmmVSmj6QErzaElGZS7NKZJUvY5uLhNkB2vSc76fja4cqtK1LdQcNFSbFuQlGUqaNzVLFLkjtnqX72FpREpVpkx2UKWiLyH5ktJGoBOhbgVJwsXl2p5zOuwgW7pH0r9B9nq0oKahORrPo3zJj+oYemRhXUjZbZFHUwSR1gN3zByrPUQ+KmuIisJlnUXtDlh9oooCCqvrRlj0GTQHqiJby4ylnLHvVWIryxnLRsVQqYd48ejOM5RJjScNFloAr6SauJC+5IgeDMNC7wZVmFMgxcUWgL/fjSwoJMmZRa4ZSM1/SvXxJ3UWxMzo3hJJQjVlcsfw36OMdi8BY9ulUUqVTWYRUniKVXRKDLFLJ0M5FICZW5JLGiykpuWSC5JIcnctryuU1ZRzaA5qODMirHFBuM6DV5IDCwAEJxgOqJzG/3QwB/xaNVwakig8oMcGIFmPQPKUqfNVvgzYvdQpE7dBr0NjEYLANplkZJNwYgywJA8PFIBsbbUoMyiKMRVsWfD6m9usZS8m31fbsmj/2fpyzPXT1m8dvo5EkfqzEVLPg30TI2s1OmQjckSo5t20uhzL4MEvfDRC1GZfKWQ+iTOl+W6Mv6U2QboSo0YWo14XfhIjanvVZyfFnsV3/KZMYxF+TJ7mMpB5LacpOgq/3L6cjG83RHvJ1pH35mJU45fv52/e36f/dt/mR1hOSUs6Fso3mcrZmZeAbl3p/zEF7einTXqqcPMUcyGU7ysrCPVzq43KbrNdv9FptH8GSmR/KYZuLMZKVgcZ6retpc6mxvVRJUy61uxlLqUwQxKWYD0LGesJmCVr1glQWfrRtfnsoxxhGsWW8HiUI+j7JPVOXu53TUMsz0ZzceaUhfL7dL1cS+YttKHp6EcX+81ptvd8/DnVeIWu+QUpxlNljs8SewDYfwI7KyPn3x/u343WTPdl6ebUiC10knp0Efiv9TDl4tOQWsZ6j8tylBXCehGw8zCHfdBPEn8HkQl8xE+AyJHTCSzDI0CDfQEetQSmdQTd0h/RfzDWcNAUlzcUknL4pdINB/nbG32rrlFkAzBFUVEcqubH+0u1A56+bHHnbxiXGksAOJXBl+VxJe8+52sl1UDUsTVTVG1jRRtnP6vz1/fJ+2tyhiWQuTvGUitMylvUYS03aWFwLVxwttLer+fXo+mdM/QWvstYnGOXGcn5fCtwOnEu6TOsfii4MtWOccljS8wr8AoYMpKpzJuuAw+ePCJew9LIv+6gvr8qXNg6+nA1o1RfK/Ybic2CSQMaJiHkPcGjtAFdB29bi+ZySmeHbU6bcT9HZjNNSGX5dLnQ7/zodTu+0nwhpFz66+qZ05yQEM7mGtHVHMUcpLcYmg4ZqaPKJzoq+bDChaFJA35C61SYlYljvi2QStJCu+IDobp7Ku0c3xFw+MVTC5nKr6LBpMCvUYPCLgXNuclFDa+BMGvRwCeWIt0EJO5ZHORyv1+Ofzxp9VoLYbidG2a5xFfpynOySTe5naO1Ek5XoaPnHS/+EraantvTCRmXeHyQKAgdSGqYkfKvAeT7B7cxKDkmrPkTBBqXPTgQvpcEz8ruejjeGO0kl84A4njaNeb3OrAmSIrRRbmuUKXvLP4YeUHmkHwe6uxplexkqmdUct4eI1rle/vG8kb6fNxw5kco49AgyykD1mgR3pVYKaTukzEJ4Cjp8sI54ZAqg/cx2drpyWWSmlVVSv2eaHzFFybEQ0R+htpCtcTGM07a1pbVF3y6LVrijErjuZzLGNinOWjQ0tmrTYhKznRuSSV0+yhCN0t9dxPQSGTL5+GphozIzZBEjFO1l0ukDTdGMkmItYu7T/1w+Ttd5YmpvpkokOA8R1Gnt1Ss+2bq3jUvW9iOqZYElpGK0Seo898YnUkcBKzGiw7LDdFQ0Wp88HHRSgw0UsdlHZZX2sv3MrdM3E05p4kGdJahdwjlb7+U093+43pdWDeSRIylmVRaYFaGLzI1I0nMkKNOEztdNGWhbtFXLKeFEOa2feDssCaK0dj+QXm3aYTfn+/SKuDa2zVtqlSL8Jack+v84fhwnZafjl9qUo1RTJ0AbtN0L/3H5Qvf7sQ0RZgzeHJShs00KYJsZNnlT+DiUIfl/MJvGkpK94rwmIMXaWiUqk0LnK0gdvQhw14nijZOIiYQu8GVbdWUxfNmgEJXBsAFf4iWhnIOh9lkDqkVjVIN+OwYDF6ddCiXdNYYDupsK77OpxlxsxbDw3pTaOq0BQ9rkGKwjpstVQViLF10+ZMQSfblFX+4Qs2tD7Q2HtqwIaViEOm1W9t2c7v6P6diin1r7QQDsjfDAnNL2fTu+f3scv1Grl4zsinXmFa6DbvomKcNUb8fbPGbtn2TvJV0tESI3UZn8t8hc6+LoQU52S6csb56lLZXHrA9wm4hvgIeVB9osdPPU5BBDuDsq8cYsUnzo1npxSro211KxmdqkBWHR9rG8+rEEj8YSZh1LpGksnYfH8m2PZccYC5t3GKU2KEsqpzv8xQ8x25bOVF4A1u6U2VJvx3+TvdG2Com5LBjBEkqUDa3CMREllv8mFpsrlm0hle0loRlOVoY9pP6BrfKgp53RNoJ9O91uh8uv0/Xt+EENDDJPUJnaucmwM6QdKxq4Ya9HJo1BxB1GaAnwlgV0xVb2JXDkSzoIBpCg7T0am2BkeaitXMrLKv9NLHtxLHG2VGLjqZLAEgTDMYbwrhlcPe4wBNzjIbFh5pqlhKZyA564hnFr20ILvxOzkm2qiUjKvLgld4JtO9MtNFCgPMBY/NexHGdjySZxOMkHUyPnyj3q8v7t4/L2RnWDdDMpq1reqdbL+nk8vx8u72+sGySZsIu11u38s8j76X1xPH5eXslZmNoSUJuUnU1+Ht+nM3X5I5I/TZqOwAMcla/1J/tmibgE/Usez68MUz0L6Wg6Pql1QGfFAYMB4lB/6czm3xYCRgKza0afVRpKP0/3I9V53+p86dJevjZ0KhqLQetgrw1KLvBzcoV/Pn5SlWkt7IShStoZMD/Ptxvzq0NbNW0w+ds6TKjSNt18Cj+gO/Xh6+XBUEkiGfXYfbyy58bzErjC9gKkKb+tU6e0a75txkfaEyM3cNqAlZr5eLufZ7/7sKmtN5F23nwqSp3GgPajRlmdVy8mlMebRM24cjnswJjCYpTOKpuTQ+KdGP8e8a2NaHM7KlMbFnHEG24TO9BabUQHRnx3xgE3I9918lxg0GF2fUKaYoLlYNDl2aD5osHsMaRRWrSjs1g7a+BfIqHSmhojqzNa4KsFxM0CurOhJZyNdZIYQqra+Z/zSjGwQ5r04YGjsvny++n0ejvMEc/DWmlHDT0SpFWaje+nPw6n1zNNPfKkIY922MMkaiPJtmwMMTNXc3ExhMgrgx7v82yuNexHdp7mMjo5zBxwpG2ghapaJIk4GDRAvhbjHK1XRqzm67Jura31lLE0WZnL8H55+0IPKU/sGt0B+z6f2syqIw5JsYYj8KFSKy7XP07fNn7e2Pp5CCJhM3DKScDbnMNA5rcYZXbB5QfdqkkUsfi8I46IosfFb8AYF6QyBaS8l00FzX7RLHLa55BhjuGdBrOCDOw+U4M/4FgOgTkkNBmPlA6QfpPruEpbra46r6kOVqqoAOYfLISk3APE2XztZhJxgielW7DpoOvJYJCao6BsoXe5nr+d6S2OmbQnB8oJ6KAdlCGcyx/vVB1j28HHjnXwj7IW6ON4pEdI6xrYqAy7P8HDYe3HKQ+oIMPxjLJnwFPws8+nJLZlWVabXIZOGvTFk6ovNHgfoMMDjOYBY12tq7907xAXZ/ZbW7aPQT3VOYt1iiYsnoTPMGE0VIUcKGeZ7BfkM6LH6ljLNtS6ghs/SEQ8EqxYR2koHYxGvCQ9kCbUSMu0ypydrfTXyeebm1D3XEpDXMp6QWUX8O0FuxciredgTI7KssjfNZuJbfsdi5zJaeV0Z5ckX3hBkWQVWcwV1rZj37mMdLW2x56tNMoq61ikq82J7OwiJJMCtE87KRcXYSRtWvkmWly2El+cDI+ivIJZQynugwsRChjEdxZLNF2LAz6OtxunQ761pycbAKkGGNw8wk2pI9Sf1Xa/v+J2KPxIPusBZW0BpgsqCKxTztF6XoZDo5gpv1R+Xauwjaz2mw1K6+XjdN3kjnjSHAtJysYpO5h8zKNiufXrWusX7xA++3OE9+9lf2eV1o6Mu4BJZ/C1T+6MUvlYWhZhZdijjK2Zyxin45V1Ix+XzQCatp9XrhkWCMm4oHPuPi7X++PbY5PF0HbIqYkRCMG4oDxoL7fbeU4GXZNP2BSsSAwFbZfwIrMjsvXpnHL4wFwl9du+zoYgYe2R1pMs962j/X2Vdn/3GlL9HWmMp3QElgvMU+teWMiiNVg/K0nqNUlMduWusZUolO8T21qZi9dIliS2NpX6O4bEfz5O1zM9o1tPXwkttgLFVSWpAP9LwcJSkMxzZfbc9gLSGrfmnvbInAV/nHm2SxtSVo5LaiRJrZqII6xsyD+L/PJ4+7H5ktpNS72zQpT0TtpvUzk3o4j8diLIzhJj47OShFa97ew3ZXX9VqD0zG1nEmUCMhEssAhLVPAvi5Tutm0srExoJqKFD731W5SG/VaidK9tW2FlQ5VGsiSx3eyUpSWzxJfvx/dvrEc5aez/WUnSOhpiwv1ViXLzc09i2HrtZ8KlVj/tjqTkcI3kzu3S6fWfFSrcJkl4+4R99vpl05qZ9E/W69BTktTlh1g0n7i30tyIGVsNatErZhUmtXZvVFOb4kWFCpZH67Jow5mSTFGFbHu4OWVyuSheWo62aZQSBi+yyx+STIk2aPppUfL300YS1WGqRqqgpGT6l7LL+SzyOW2PBjqb6M2nJcmvm3bA1X9DT6HCSybdf5VJnbPEeQAWedq2C6H+LJ/FSKdEO8ZdmYPNxckrSHq2KnOYuWSpeXs790rJkIvYzo22RrUSoxeJ0nsmjVX1z73++5Z/tM1U9Hvk8q87T9oWMClJKURK74JM3dEfXYjDCu54W0ypDZwKIiVVb1OLtAxkR7TU6t23O9Ffv4Qkullrr6TlRLS0cbYy9ZrKRcrK1lYHR2UCkiRdWIs2Oqadf01Eb/bU9r39BT3ubq7txFP9ISLK7ZxTbWf9v6IWv9lu2wCBdgjqRn7n1skEg7/4FqVbbg4ebTE9kbvNtWpTEPTxXS5R1JBmk/9E/K0jufMltg3AtES+fxFhyVsjIigngQlXkG+/NXjCX9lIVuHSntp+nsqpOETyr/PpD5pI1wj8C5o3yxO1pOWT+nNblNvRkbZHmHLOXfcS0pbdtlBTdmPcyO/cetsITkvSuGjpllv76xP7U2kgSRNj2mIsLZ4lwuQBKO0Rnj8RIa1ypTaMbVXWJ0Lh19Ov2+v569dWWAtmP2ENF1ES/GnjWtryvVmmkEPbar3+5p774dwihU36aLVcr4lEnqzk7fiDpJxXsREtKHkbwUzaXI0qV9iriHGmP2wUB9nYmtf58++ruzuNjijpZzWqc7Ntyusnto/eaTW2+bn5E4FCfki1N/aJWE7vbGrXzunfye+PpLa2xH/ipfzmJGobzvhPREf7B1BbWOY/EbvvnDstqXKfCD3N4qSwaBu4/JzW7NDY1nT6hFsgSJXsstYo/oQd1UiXpLZGvPaer6evp+uV0rTUBv9tKqUD0y+t0MvLXL07qdL9wYIfZMCdsmHXU54gzpFGTaUE3FhtlPR6+XadJFOZpKYMVbNqPHu90NkbPpAqeuR3R23eyIMmFSWCP7I2CvPozfAmbVY+L0tqeN6+Fe2gm0nodsz2y+wEf3tct/Owm5v+PxIvDewhhFGp/JPYt8vjdd5Fn/O5+k9BYr3/J+LlszqRnCit5fabS0npFnQ8lH7FLtdbf5Va01C5wQsipakwpAeUlm8/7uJQmDatUq2TOzNhSIqcNt3ksTcsu53kq/4oqbwOO2xnZWsDrVy0NGymjZVrz/aHPMm6ra/+tCT5sVtHzSkryxuh0gO37ZC1aQePncm9xEb/S+LkDEiazaH11x6/ndxLJtkbZRvHSe7vhsmSKO//QmgnSEE6EOi/VeW02nZnGbTRx4c8aLJ1h9Vvrdn+hafPZKDo56VKGzM5r5RZMv+k22drw6IJVETqdUQB9ojKq1HpLgleiGntKNuMgVt/uFIo50t9lVeejvO1WDFHGy8urS0CZk+U0o2MEteAnhihzo4aUAeu7NG33Mhh+7KiJ30APrGEwpuPI0mbUOaA0iEdZGxuMbdRl59QRBCRJx/RVw39cuygRNLXOYOKmr8kfofaudqfPCtf/XWTRDe2OUC51O9m1PSHol3Tr1LIgModG5QDG6br/uBtPUgNwIAa8kF5qkyOMAOS7SKFOjqhNK6a1BLtCdDnIWv1YRnpRi1gskmhkd9Qv1QljBf6RJOp7WhObjAuzORaLFlbiIT6q9wDPlmrLZZf74a1x47kVSW8Kt3Bdz29PmgvAjsSPFiajRXXOJT+uaFcy6TafQ7dBAdTK+1d+VVjC2hBkJVI83r6St9CIG8BZdlo5oHxPNNbQH8zfO/qj7Ke2TReRPo8K3MwG2EH3oOaTLBVzshp5L1MqnE/3Y/Xktl7urPGSbFNzJzeMfqqKJNpW+tFcIhi2wBuEoo6YGVxgyD++KA95mJbJzMJRj8YpYXfucT0/59fyHVIxQsah9pR6ZN0rrMZXdNWgNTBD6PSo/qNDTy2kDXjUx1MvQ5ekdIVbq7Iy+tInE8ZN5TB4kiaPA0BN46dLSkTC66nfz7O0/YmNHVI7Xlks5LrXE+3jxm/E0OQujDaO+O9xA31sNBKCOeVweMb9cY+X4TNh2nf04hjCp0yjUdvPe9qhSzaSKDBSUT3pOhxcKO3ynPmkfYWD9fT/XFl/QoCKdnMSpb3lCgKJDnuWZlcNEmabf/Dx+l6mBWKNSWNbcLLZA1rz4FF6Mccit+KJI39RmWgcBb5J/0myYmCymerNuF+0QRnsieW9qnFusasobGcxGNpYTmWjgPo5e1KJxdXGo+6YiznXDcqtJlBZwqDTrwGf2tq6xm09fRoiImuyAbdkI1Hg5RUu7mgM3I2+FVteUiuJtugLK5EtznyjkmbZzQWm35pFag0yXv5fnr5cWK2BBmOgU5hXhmpgHBJNhkAZWvRtLJT5CT740J5CWkd7tHJWUse58wKoqjtHjcWfxnN42CYjEUJcfKOpUEC2tyMZe0cNsNBmbEl5Y7EQGo+0XXXKYf/zTJ5tY1te7Kh1etYfAz03R4zvjl8V0rofr288T5wpFawfIq2+tWYqmwxxWk6tpVb+OXn8X3TcqAdfFrb9mMAnFPGDq+XP6j2kWm9aMA5/ULrdXQaCaF61vgzdETKaHyizY64Pt7f5wlK1K8giFPZH2mWtGl80W7/A7pb17kwTjki7fq4bTtAtOOCa3drbMpO6RC1o35vW6soEt8WbfesdjLJ7nTiSKbHu7ouyrAJhPNPMpJOhh6RN212RndGMSlbwnRK65VZL63cpRUBFd76Vh6tKb2SHrbCpTdJ5lV5TLj0yvD87eXycTr8PN82ExsDWRWtBb7NnYtkDJrF92/xrddWitrkgPUqzyuQ1SBvErGQoEwLauXywVikg60yM5Vk1Ukvj7RViHh5yuD/Kv71fPsxt0DqtZFKpNy+NvdVxkLWiwhLTT7GjI1baWk1YuXpZpH0Q4BtaYOywWR7gecKUfHtd4lRFNM2/hlVWYRt9ikycitgiFhQRmyK6Ol1blUmk94eaM6oTTxeZUty29UOrkbCP6OKq9w5ded0vZ+5cdPuA6HG2pUNk9orTNYGFU0WPMGcUDY1kgjfmAguRAx6wOjgAAcgVgikjDeXK24n/qTWcJoklz1BWxp1m3sBU1TZbjIJbZ+TWhu33RsN6SdV+9Cjt1mZu1B8AYQ1YlnIWD7ohI7QGXvTgCaEIyaVOWU2SLnfw/QF8Q6h7UoMyryxIm8WR19UIsY6XpTSG2zlsttsF1ebV89nzpAoT4DvHRCRihXgKavgp0vMYxOuv1hDYDLXEoxUfZRfl7lyLPjXiiyRVYMhImaEqzKi89qIsMKIYeIYJ20wA9s4zNp1uTrFCGc0IbvaSRd/htkg6PpnPJqWe8wB8VUyAi8YXTK9BHSShf8A5GjAgQyQo4l1VBI+l1hpfO3C7PGrGFrTV4lxWwa/6kB1h//O4xcGbKcC3k2GDwKHzGAousm451xncWCeCdoDTk51cesGNOYcymwdix7H04vGL3i8GIttsdFYA7PA4gS3yEiwGECMnFZrS0TM1uFfGN5sMdrY1vAOdM1C1yxmrFsM/LIIEljon3U4oF0d4YA7cDgEMXvNIsQ2+QroIY5V83CLMUN6Mo3gUqPlYsA2H+A+o2uxDWi7GdDTOcBYxoyAaVPDLwx2jHAWI5IgMFXHRjTSj5iOWhv4J/ScTmA/Cf5hwlMmNLvFUB777Jet2U9+ra6jYAsn0hs2Qimi1tNbhE8u3is9DxPpphGhCFHrT59uc2BwhlnTHwtYNJF2aRigZ6PaeFou0FsW0kopYvWjMpJxO83DdL68nb79+/wx/acf1/VyZEsn/TKVuTKT4HnJzy+nx5WeOQOJwij9/+/H6ytL6I3EyMP4AbgzGOplYbDYpASJ6/V6az4SlUG/TG0riDnl83h/XGldGaFdCdH6hE0qWHz6yoHkt/PPjzfWL7NRlwx0NdYe9EpuPK0NzZCYTvM2aohzsCaA6OVu2sgSNOmUfb0WUVwSmaQwap113qXYk1nbAe2/4U0YTBIydZKcxTlilRXmtx9nMkXKtGmWFkFmBGHLpBRXrA9XDhhf9m9frHhf9BbmS6hOwPP1wdCMJfgVyymG5CScDAZd280AywQTFibLrrZLR0IOvC/8i8kYwJmDczJrPajLy4/T/SDQ7UgcCKdsm7TKk8SRsVGjdrO9XGkjp7Z5RCi5eIgM4DTHwJ9YLIJYDuFYLI1YDIOIt1iWLxVrLpVLYCRoKsZBLhtOrtlKDq9JG/Ccnu8wz+y+dsKSZDi4Msfmdnlc2WAY4rVY4HkLO2hEjoCzNYYN2w3HAdC+1dagrXdz+Lhe/vUn1S/CsWy9ltKMWOWy7cqRSIat962sxFmlbm+WVLeN8N2dMot9FcvvlYz1qjMavPbb/Ti+8+bR7UGbay9teHxOG8z9OL2wKd2WVH2V7S0hxm2UFfy3O+dVtj0JffFA4JIi/xo2bCw+B8a0wO+DHWDB/ieXrG6a+Ns6DRlKkpW9eef+tvQB2m5robgA8EvglmDMFlI684hdBIm52E5gWg/K3KI50f71yGYpt4ub4ZaPdWq1MtNqGTBP2Rc5ITBCDGMGbdaCmVn0gQ0g8CQnegRMGioj1Ub1ivjD9FcsZzK1GS6TRPVCTxLv5580zE7GzDo4hV4bV56lnl4PLEs0kW1Cuz2uspgoMjZIO5VkEcXnrLf9c2yN+iPgWnJyMFW9uOuYFuaL64UxdMg/D4jEjLAFB1M/2E8swXTf01/Qd27beUS+mG5o3g9EH+DgJ2VDreWSl/fTheZspLYcZ3qDn1CyrY6RXDEEc7w2ZHA/3plA4ipE2AGIOz3nMOtEU5czkAx6zJMblK0Pt9XbhjY6qWE65FthxmlN006m/kLYRf+lT7cwjxukt0HKlbVPc/mgWkGaOisrlmYp80QUloHSulcjgrQw5qZfSLBQqx/vb5DIR5+VTVknObwwpM2uskYbYbg/SCaDJ3Fzj0Hp2jmrt/uf9BQ3xB5DMUCtBaj2hO4Cj9s8mIXlvgXSKkCZQHqbp0pyU68t66njOxD2dsps1zXdnx4TZFYF0tYswvvIvTDwjierGDNwEHdxmESKnDzrsaV75Ztf71ByIch5iwoRr6Rdz0KHrbGfiLGP+LZS4flmYdvKRICHVJYwITekzpWMygYI9+/HM1WKNl+/JraVDdA4ZZPdZ7+DjXtFiizrOHevbPZf2yiQL7lVZQO7wHiMfPQIGHkUIYSSMz790m2d9erdOGV7uEawhqd3ob0AXzRSt2ZBJrwydXI2AS50xcxA6hvKdl8nU5U/UQZY50tMJ91Pcj5FMqzZg114ZZrk/fLj9L7OiqcAgaS7a3tWLdJoSKkt8rDgkdYrGz7cL5fDdHt/HpZ5VxRLk0Q2o8xLvl/u1GVOIx1zgjidMm9oEXgQBiM4Uj+tHcK3ipuzJA+nfx1/njfFEmQMu3anWITOo1Q6Qh0RqtyZF6H/fFyuj597N0wnLujO0lX2Noe3hSxjqIAVZ5mvYBIJVIj9BVjiWelPL/chvVtPsneV7cMWafNKiQvV6qHJyuDkInJ+sbJIMpNe/RFPItfX2r1XMoNaW1W1CN6+U0feKbACoK/D+6t2TIDfUCvfs5If3a/H99sHC1q7SMwp5DmMMNVGZChgcqFB9r1xyAlxsEVdPRBRWOWRLeHhacHYMmgiYFBFPB219ReKXVDEgpTSydnHL9wLglrTYYO/RUZGwN1XXz4iColUKRPhroG1G4ybNwjIGwTiTU2hSiAlCaYAuLpJdcTsUJFaPRfxC1kuGVkkGY7/YGs0rnzgA5hxRacGOQgGZiiO48nFqaNty3ZiclVHUC5kD1jEwzGF3Vpkh1hsRdAma+GvW9w9KlcmIZiIiScCabIjVH7EnY4IizoU6DgADlezPmAfe1RuIIfIInNo+sDwqSHvBOVUFuWBFuHTyTeqeR1oTIC3ELCSofJkSAEAshHZKxF3FbEVREiJICARVCQhGwY5RDYhkQIxcJtqi4x6DAx186gV+soj6vpgAfK2F3t5lb7sFfjYkNeCxCk8cyzuRiw5nYiKVGCelZ7t/XH9sXFH23ahtYbD1LCDcgv984M+e5t7jR4BqegBUmoSdhyL/QhZTwZfggERnH4hzww2uYGGG+T+GOQmGbxng/wdUzPZa4YToAgGYk+/8GejUgumlWDDfEiZcAbGwwaHCjUz1vRBZcXI4/3r8dfleno98FcQiCOgDXc91snIM+wRLOxExhY/X8pnZEoiSZaJEg48Pl5ZRNS2TrQvK+rLggKBorgZvXJC0bdQNnfkTaNxDJJnkWYWi5xYtnVkm8Xi1CDXDFtSKqcpEicS9ukBu9+A3WqAPg91t4IDjzPSZiUpXdeNBwg8maQ6on3NiIBR3aMz7jIr/aH1mmzyD5mNpuxR9xTESUsmxElZe/GUxUkLCfMpO6uuoq4HoRQvkArXpMxifgoU5bXPmpT27SpvLmTfDMkOtJmhMsnwKZAqkSFVPM1Zvf5wJWAGwoYyNl+Oc+Qko/IS2Z9mRJgEdeaTlYpvAvZMVu7Tz2cQ12Qki1xzQ3E17cb30Q1ZtfsozOTpl/KTormG0ZDYp61Wow6APW4c7gdSITnAVtO2znzcTod52OSBBamjJxOmlThnlrZUpH9ceClC9KROVLsNTgI39WKBVOYPyjrWSZQwozWOpF+Nst3uJKv3mK1/PVn5uijPJG/zlLZ9s7Ecj7CqYnEzY8l+T4UB1/bQg9Iinq5PSxTJsE1bs+dqbjlyB72yTmm+xuHlTiv/CLl1yjD3LOnl8s5BQCKvsh7X2jFhi1h2f21x0vQ2sVem6tdov9zTdRHUSqeDq+E/oVGH1UYJHw+K4D1pfRXg58dBabVN8qjxRxYi1ewe7cc3C9yWCibytSTkjSZlXOrX8e282Elz5snW1AwkQpWUFkcROv+FILI92LVZ7ZNI6nIGS+yNWmBTyxWQnpSVHQZ+Ha/n4ztdXzJpHhU9FqawjcpopVCoYEiHCWDHqOza9+t05Yn9iRyPMNwtSv4s8n6nG1cuPRtFYUiSDrxatN5IcEjgh6BPaIkDwDNBKadF+ZItdzhtlggooZbeIg5qYQhpO8nNT3KYSyKOL5tWd5GAQyWaXgRuT1eS7JCUcGaRtfFsSQrGoEzln0UJd0V6CQ76J3x2hpU2H2Lb4R1pZ90U4bSbryMlskAZWQmRZqHSrbbfWkasIyszfapUXu7sSOoUAoFZ2b9tFkzRHpk0gKifScrY1yxwq0akfSbSjQZlW0o6L4003oddZaKyJviP4/nO/BAXiLWk3FGfgg4vb+cTL9ttmyiapGRUEDj9V+c7PW0GIk/3HT7lifdHzlWlk1XkbW+PjCPXDu7943jdeN2kedOAkPigbND2x/fz7GkeaXr/2IaHMyjLiMZk2o5g06423/Fh7hF1uLy/sWybTExhpTauImeJG4FkexuVh8wfl+uPyU7/MtdKHDaNLkiGmlNm0TxFPkfGnFiTNZJvOeo2yVXico+bWyT776hspLcKlO/QkVZ/yoyPP65najd6gp1DjYzUYwfmgnYi9HIR1piztU4RiTRDjb9ophD/19//9nH+OL2d3ydB//lf//M//z9BOZAF"; \ No newline at end of file diff --git a/docs/0.12.1/assets/style.css b/docs/0.12.1/assets/style.css new file mode 100644 index 000000000..2ab8b836e --- /dev/null +++ b/docs/0.12.1/assets/style.css @@ -0,0 +1,1611 @@ +@layer typedoc { + :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + html { + color-scheme: var(--color-scheme); + } + + body { + margin: 0; + } + + :root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + + :root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } + + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } + + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } + + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } + + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } + + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } + + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } + + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } + + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } + + dl, + menu, + ol, + ul { + margin: 1em 0; + } + + dd { + margin: 0 0 0 34px; + } + + .container { + max-width: 1700px; + padding: 0 2rem; + } + + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } + + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } + + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } + } + @keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + } + + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } + + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; + } + pre:hover > button, + pre > button.visible { + opacity: 1; + } + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; + } + + .tsd-typography { + line-height: 1.333em; + } + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); + } + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } + + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } + + .tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } + + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } + + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } + + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } + + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } + + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } + + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } + + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } + + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } + + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } + + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } + + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } + + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } + + .tsd-anchor { + position: relative; + top: -100px; + } + + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } + + .tsd-navigation.settings { + margin: 1rem 0; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } + + .tsd-page-navigation-section { + margin-left: 10px; + } + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 20px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } + + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } + + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + .tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + * We need to be careful to target the arrow indicating whether the accordion + * is open, but not any other SVGs included in the details element. + */ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h5 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } + + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } + + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } + + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } + + #tsd-search { + transition: background-color 0.2s; + } + #tsd-search .title { + position: relative; + z-index: 2; + } + #tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; + } + #tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); + } + #tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; + } + #tsd-search .field input, + #tsd-search .title, + #tsd-toolbar-links a { + transition: opacity 0.2s; + } + #tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + #tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; + } + #tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search .results li.state { + display: none; + } + #tsd-search .results li.current:not(.no-results), + #tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); + } + #tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; + } + #tsd-search .results a:before { + top: 10px; + } + #tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; + } + #tsd-search.has-focus { + background-color: var(--color-accent); + } + #tsd-search.has-focus .field input { + top: 0; + opacity: 1; + } + #tsd-search.has-focus .title, + #tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; + } + #tsd-search.has-focus .results { + visibility: visible; + } + #tsd-search.loading .results li.state.loading { + display: block; + } + #tsd-search.failure .results li.state.failure { + display: block; + } + + #tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; + } + #tsd-toolbar-links a { + margin-left: 1.5rem; + } + #tsd-toolbar-links a:hover { + text-decoration: underline; + } + + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } + + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } + + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } + + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } + + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } + + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } + + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; + } + .tsd-page-toolbar a.title { + font-weight: bold; + } + .tsd-page-toolbar a.title:hover { + text-decoration: underline; + } + .tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; + } + .tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; + } + .tsd-page-toolbar .table-cell:first-child { + width: 100%; + } + .tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; + } + + .tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); + } + .tsd-widget.no-caption { + width: 40px; + } + .tsd-widget.no-caption:before { + margin: 0; + } + + .tsd-widget.options, + .tsd-widget.menu { + display: none; + } + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; + } + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; + } + + img { + max-width: 100%; + } + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; + } + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + } + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; + } + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; + } + + .deprecated { + text-decoration: line-through !important; + } + + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); + } + + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); + } + + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + /* mobile */ + @media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } + } +} diff --git a/docs/0.12.1/classes/ChangesFollower.html b/docs/0.12.1/classes/ChangesFollower.html new file mode 100644 index 000000000..27f504699 --- /dev/null +++ b/docs/0.12.1/classes/ChangesFollower.html @@ -0,0 +1,95 @@ +ChangesFollower | @ibm-cloud/cloudant - v0.12.1

A helper for using the changes feed.

+

There are two modes of operation:

+
    +
  • startOneOff to fetch the changes from the supplied since sequence +until there are no further pending changes.
  • +
  • start to fetch the changes from the supplied since sequence and +then continuing to listen indefinitely for further new changes.
  • +
+

The starting sequence ID can be changed for either mode by using +CloudantV1.PostChangesParams.since. By default when using:

+
    +
  • startOneOff the feed will start from the beginning.
  • +
  • start the feed will start from "now".
  • +
+

In either mode the Stream of changes can be terminated early by calling +stop.

+

By default ChangesFollower will suppress transient errors indefinitely and +endeavour to run to completion or listen forever. For applications where that +behaviour is not desirable an alternate constructor is available where a +errorTolerance may be specified to limit the time since the last successful +response that transient errors will be suppressed.

+

It should be noted that errors considered terminal, for example, the database not +existing or invalid credentials are never suppressed and will throw an exception +immediately.

+

The CloudantV1.PostChangesParams model of changes feed options is used to configure +the behaviour of the ChangesFollower. However, a subset of the options are +invalid as they are configured internally by the implementation and will cause +an Error to be thrown if supplied. These invalid +options are:

+ +

Only the value of _selector is permitted for +the CloudantV1.PostChangesParams.filter option. +Selector based filters perform better than JS based filters and using one +of the alternative JS based +filter types will cause ChangesFollower to throw an Error.

+

It should also be noted that the CloudantV1.PostChangesParams.limit +parameter will truncate the stream at the given number of changes in either +operating mode.

+

The ChangesFollower requires the CloudantV1 client to have +HTTP call and read timeouts of at least 1 minute. The default client +configuration has sufficiently long timeouts.

+

Constructors

Methods

Constructors

Methods

diff --git a/docs/0.12.1/classes/CloudantV1-1.html b/docs/0.12.1/classes/CloudantV1-1.html new file mode 100644 index 000000000..05e156444 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1-1.html @@ -0,0 +1,2089 @@ +CloudantV1 | @ibm-cloud/cloudant - v0.12.1

NoSQL database based on Apache CouchDB

+

See: https://cloud.ibm.com/docs/services/Cloudant/

+

Hierarchy

  • default
    • CloudantV1

Constructors

Properties

Methods

configureService +createRequest +deleteAttachment +deleteDatabase +deleteDesignDocument +deleteDocument +deleteIndex +deleteLocalDocument +deleteReplicationDocument +getActiveTasks +getActivityTrackerEvents +getAllDbs +getAttachment +getCapacityThroughputInformation +getCorsInformation +getCurrentThroughputInformation +getDatabaseInformation +getDbUpdates +getDesignDocument +getDesignDocumentInformation +getDocument +getDocumentAsMixed +getDocumentAsRelated +getDocumentAsStream +getDocumentShardsInfo +getIndexesInformation +getLocalDocument +getMembershipInformation +getPartitionInformation +getReplicationDocument +getSchedulerDocs +getSchedulerDocument +getSchedulerJob +getSchedulerJobs +getSearchDiskSize +getSearchInfo +getSecurity +getServerInformation +getSessionInformation +getShardsInformation +getTimeout +getUpInformation +getUuids +headAttachment +headDatabase +headDesignDocument +headDocument +headLocalDocument +headReplicationDocument +headSchedulerDocument +headSchedulerJob +headUpInformation +postActivityTrackerEvents +postAllDocs +postAllDocsAsStream +postAllDocsQueries +postAllDocsQueriesAsStream +postApiKeys +postBulkDocs +postBulkGet +postBulkGetAsMixed +postBulkGetAsRelated +postBulkGetAsStream +postChanges +postChangesAsStream +postDbsInfo +postDesignDocs +postDesignDocsQueries +postDocument +postExplain +postFind +postFindAsStream +postIndex +postPartitionAllDocs +postPartitionAllDocsAsStream +postPartitionExplain +postPartitionFind +postPartitionFindAsStream +postPartitionSearch +postPartitionSearchAsStream +postPartitionView +postPartitionViewAsStream +postReplicator +postRevsDiff +postSearch +postSearchAnalyze +postSearchAsStream +postView +postViewAsStream +postViewQueries +postViewQueriesAsStream +putAttachment +putCapacityThroughputConfiguration +putCloudantSecurityConfiguration +putCorsConfiguration +putDatabase +putDesignDocument +putDocument +putLocalDocument +putReplicationDocument +putSecurity +setEnableGzipCompression +setServiceUrl +newInstance +

Constructors

  • Construct a CloudantV1 object.

    +

    Parameters

    • options: UserOptions

      Options for the service.

      +
      • serviceUrl

        The base URL for the service

        +
      • headers

        Default headers that shall be included with every request to the service.

        +
      • authenticator

        The Authenticator object used to authenticate requests to the service

        +

    Returns CloudantV1

Properties

timeout: number
_logger: SDKLogger = ...
DEFAULT_SERVICE_NAME: string = 'cloudant'
DEFAULT_SERVICE_URL: string = 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud'

Methods

  • Configure the service using external configuration +Cloudant specific extensions:

    +
      +
    • Apply the new base service options on CouchdbSessionAuthenticator.
    • +
    +

    Parameters

    • serviceName: string

      The name of the service. Will be used to read from external +configuration.

      +

    Returns void

  • Extend createRequest to handle document and attachment validation.

    +

    Parameters

    • parameters: any

    Returns Promise<any>

  • Delete an attachment.

    +

    Deletes the attachment with the filename, {attachment_name}, from the specified doc. You must supply the rev +query parameter or If-Match header with the current revision to delete the attachment.

    +

    Parameters

    • params: DeleteAttachmentParams

      The parameters to send to the service.

      +

      Parameters for the deleteAttachment operation.

      +
      • attachmentName: string

        Path parameter to specify the attachment name.

        +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Delete a database.

    +

    Deletes the specified database and all documents and attachments contained within it. To avoid deleting a database, +the server responds with a 400 HTTP status code when the request URL includes a ?rev= parameter. This response +suggests that a user wanted to delete a document but forgot to add the document ID to the URL.

    +

    Parameters

    • params: DeleteDatabaseParams

      The parameters to send to the service.

      +

      Parameters for the deleteDatabase operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.Ok>>

  • Delete a design document.

    +

    Marks the specified design document as deleted by adding a _deleted field with the value true. Documents with +this field are not returned with requests but stay in the database. You must supply the current (latest) revision, +either by using the rev parameter or by using the If-Match header to specify the revision.

    +

    Parameters

    • params: DeleteDesignDocumentParams

      The parameters to send to the service.

      +

      Parameters for the deleteDesignDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Delete a document.

    +

    Marks the specified document as deleted by adding a _deleted field with the value true. Documents with this +field are not returned within requests anymore but stay in the database. You must supply the current (latest) +revision, either by using the rev parameter or by using the If-Match header to specify the revision.

    +

    Parameters

    • params: DeleteDocumentParams

      The parameters to send to the service.

      +

      Parameters for the deleteDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Delete an index.

    +

    Delete the index functions from the design document and index files on the server.

    +

    Parameters

    • params: DeleteIndexParams

      The parameters to send to the service.

      +

      Parameters for the deleteIndex operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • index: string

        Path parameter to specify the index name.

        +
      • type: string

        Path parameter to specify the index type.

        +

    Returns Promise<Response<CloudantV1.Ok>>

  • Delete a local document.

    +

    Deletes the specified local document. The semantics are identical to deleting a standard document in the specified +database, except that the document is not replicated.

    +

    Parameters

    • params: DeleteLocalDocumentParams

      The parameters to send to the service.

      +

      Parameters for the deleteLocalDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Cancel a persistent replication.

    +

    Cancels a replication by deleting the document that describes it from the _replicator database.

    +

    Parameters

    • params: DeleteReplicationDocumentParams

      The parameters to send to the service.

      +

      Parameters for the deleteReplicationDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • docId: string

        Path parameter to specify the ID of the stored replication configuration in the _replicator database.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Retrieve list of running tasks.

    +

    Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the +currently running tasks, with each task described as a single object. Depending on the operation type, the set of +response object fields might be different.

    +

    Parameters

    • Optionalparams: GetActiveTasksParams

      The parameters to send to the service.

      +

      Parameters for the getActiveTasks operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.ActiveTask[]>>

  • Query a list of all database names in the instance.

    +

    Query to retrieve a list of database names from the instance.

    +

    Parameters

    • Optionalparams: GetAllDbsParams

      The parameters to send to the service.

      +

      Parameters for the getAllDbs operation.

      +
      • Optionaldescending?: boolean

        Query parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Query parameter to specify to stop returning records when the specified key is reached. String +representation of any JSON type that matches the key type emitted by the view function.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Query parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalskip?: number

        Query parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Query parameter to specify to start returning records from the specified key. String representation of any +JSON type that matches the key type emitted by the view function.

        +

    Returns Promise<Response<string[]>>

  • Retrieve an attachment.

    +

    Returns the file attachment that is associated with the document. The raw data of the associated attachment is +returned, just as if you were accessing a static file. The returned Content-Type header is the same as the content +type set when the document attachment was submitted to the database.

    +

    Parameters

    • params: GetAttachmentParams

      The parameters to send to the service.

      +

      Parameters for the getAttachment operation.

      +
      • Optionalaccept?: string

        The type of the response: /.

        +
      • attachmentName: string

        Path parameter to specify the attachment name.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionalrange?: string

        Header parameter to specify the byte range for a request. This allows the implementation of resumable +downloads and skippable streams. This is available for all attachments inside CouchDB.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<ReadableStream>>

  • Retrieve change events for all databases.

    +

    This endpoint is not available in IBM Cloudant.

    +

    Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating +or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order +and might repeat changes. Polling modes for this method work like polling modes for the changes feed.

    +

    Parameters

    • Optionalparams: GetDbUpdatesParams

      The parameters to send to the service.

      +

      Parameters for the getDbUpdates operation.

      +
      • Optionaldescending?: boolean

        Query parameter to specify whether to return the documents in descending by key order.

        +
      • Optionalfeed?: string

        Query parameter to specify the changes feed type.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalheartbeat?: number

        Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

        +

        Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

        +
          +
        • Use the timeout parameter with a value that is compatible with your network environment.
        • +
        • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
        • +
        • Use TCP keepalive.
        • +
        +
      • Optionallimit?: number

        Query parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalsince?: string

        Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

        +
      • Optionaltimeout?: number

        Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

        +

    Returns Promise<Response<CloudantV1.DbUpdates>>

    this method is deprecated and may be removed in a future release

    +
  • Retrieve a design document.

    +

    Returns design document with the specified doc_id from the specified database. Unless you request a specific +revision, the current revision of the design document is always returned.

    +

    Parameters

    • params: GetDesignDocumentParams

      The parameters to send to the service.

      +

      Parameters for the getDesignDocument operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<CloudantV1.DesignDocument>>

  • Retrieve a document.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    • params: GetDocumentParams

      The parameters to send to the service.

      +

      Parameters for the getDocument operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<CloudantV1.Document>>

  • Retrieve a document as mixed.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    • params: GetDocumentAsMixedParams

      The parameters to send to the service.

      +

      Parameters for the getDocumentAsMixed operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Retrieve a document as related.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    • params: GetDocumentAsRelatedParams

      The parameters to send to the service.

      +

      Parameters for the getDocumentAsRelated operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Retrieve a document as stream.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    • params: GetDocumentAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the getDocumentAsStream operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Retrieve information about all indexes.

    +

    When you make a GET request to /db/_index, you get a list of all the indexes using "language":"query" in the +database and the primary index. In addition to the information available through this API, the indexes are stored +in the indexes property of their respective design documents.

    +

    Parameters

    • params: GetIndexesInformationParams

      The parameters to send to the service.

      +

      Parameters for the getIndexesInformation operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.IndexesInformation>>

  • Retrieve a local document.

    +

    Retrieves the specified local document. The semantics are identical to accessing a standard document in the +specified database, except that the document is not replicated.

    +

    Parameters

    • params: GetLocalDocumentParams

      The parameters to send to the service.

      +

      Parameters for the getLocalDocument operation.

      +
      • Optionalaccept?: string

        The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

        +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +

    Returns Promise<Response<CloudantV1.Document>>

  • Retrieve the configuration for a persistent replication.

    +

    Retrieves a replication document from the _replicator database to view the configuration of the replication. The +status of the replication is no longer recorded in the document but can be checked via the replication scheduler.

    +

    Parameters

    • params: GetReplicationDocumentParams

      The parameters to send to the service.

      +

      Parameters for the getReplicationDocument operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • OptionaldeletedConflicts?: boolean

        Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

        +
      • docId: string

        Path parameter to specify the ID of the stored replication configuration in the _replicator database.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • OptionallocalSeq?: boolean

        Query parameter to specify whether to include the last update sequence for the document.

        +
      • Optionalmeta?: boolean

        Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +
      • OptionalrevsInfo?: boolean

        Query parameter to specify whether to includes detailed information for all known document revisions.

        +

    Returns Promise<Response<CloudantV1.ReplicationDocument>>

  • Retrieve replication scheduler documents.

    +

    Lists replication documents, including information about all documents, even the ones in a completed or failed +state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and +other information.

    +

    Parameters

    • Optionalparams: GetSchedulerDocsParams

      The parameters to send to the service.

      +

      Parameters for the getSchedulerDocs operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Query parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalskip?: number

        Query parameter to specify the number of records before starting to return the results.

        +
      • Optionalstates?: string[] | States[]

        Query parameter to include only replication documents in the specified states. String must be a +comma-delimited string.

        +

    Returns Promise<Response<CloudantV1.SchedulerDocsResult>>

  • Retrieve replication scheduler jobs.

    +

    Retrieves information about replications that were created via /_replicate endpoint, as well as those created +from replication documents. It doesn't include replications that completed or failed to start because replication +documents were malformed. Each job description includes source and target information, replication ID, history of +recent events, and other information.

    +

    Parameters

    • Optionalparams: GetSchedulerJobsParams

      The parameters to send to the service.

      +

      Parameters for the getSchedulerJobs operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Query parameter to specify the number of returned jobs to limit the result to.

        +
      • Optionalskip?: number

        Query parameter to specify the number of records before starting to return the results.

        +

    Returns Promise<Response<CloudantV1.SchedulerJobsResult>>

  • Retrieve information about a search index.

    +

    Retrieve search index metadata information, such as the size of the index on disk.

    +

    Parameters

    • params: GetSearchInfoParams

      The parameters to send to the service.

      +

      Parameters for the getSearchInfo operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • index: string

        Path parameter to specify the index name.

        +

    Returns Promise<Response<CloudantV1.SearchInfoResult>>

  • Retrieve database permissions information.

    +

    See who has permission to read, write, and manage the database. The credentials you use to log in to the dashboard +automatically include _admin permissions to all databases you create. Everyone and everything else, including +users you share databases with and API keys you create, must be given a permission level explicitly.

    +

    Parameters

    • params: GetSecurityParams

      The parameters to send to the service.

      +

      Parameters for the getSecurity operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.Security>>

  • Retrieve server instance information.

    +

    When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response +includes a JSON structure that contains information about the server, including a welcome message and the server's +version.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    • Optionalparams: GetServerInformationParams

      The parameters to send to the service.

      +

      Parameters for the getServerInformation operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.ServerInformation>>

  • Retrieve information about whether the server is up.

    +

    Confirms that the server is up, running, and ready to respond to requests. If maintenance_mode is true or +nolb, the endpoint returns a 404 response.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    • Optionalparams: GetUpInformationParams

      The parameters to send to the service.

      +

      Parameters for the getUpInformation operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.UpInformation>>

  • Retrieve one or more UUIDs.

    +

    Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that +provides a list of UUIDs.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    • Optionalparams: GetUuidsParams

      The parameters to send to the service.

      +

      Parameters for the getUuids operation.

      +
      • Optionalcount?: number

        Query parameter to specify the number of UUIDs to return.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.UuidsResult>>

  • Retrieve the HTTP headers for an attachment.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified attachment. This method +supports the same query arguments as the GET /{db}/{doc_id}/{attachment_name} method, but only the header +information (including attachment size, encoding, and the MD5 hash as an ETag), is returned.

    +

    Parameters

    • params: HeadAttachmentParams

      The parameters to send to the service.

      +

      Parameters for the headAttachment operation.

      +
      • attachmentName: string

        Path parameter to specify the attachment name.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a database.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified database. Since the +response body is empty, using the HEAD method is a lightweight way to check if the database exists or not.

    +

    Parameters

    • params: HeadDatabaseParams

      The parameters to send to the service.

      +

      Parameters for the headDatabase operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a design document.

    +

    This method supports the same query arguments as the GET /{db}/_design/{ddoc} method, but the results include +only the header information (including design document size, and the revision as an ETag). The ETag header shows +the current revision for the requested design document, and if you requested the design document in full, the +Content-Length specifies the length of the data. If you add any of the query arguments, then the resulting HTTP +headers correspond to what is returned for the equivalent GET request.

    +

    Parameters

    • params: HeadDesignDocumentParams

      The parameters to send to the service.

      +

      Parameters for the headDesignDocument operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for the document.

    +

    This method supports the same query arguments as the GET /{db}/{docid} method, but only the header information +(including document size and the revision as an ETag) is returned. The ETag header shows the current revision for +the requested document, and the Content-Length specifies the length of the data if the document was requested in +full. Add any of the query arguments, then the resulting HTTP headers that correspond to it are returned.

    +

    Parameters

    • params: HeadDocumentParams

      The parameters to send to the service.

      +

      Parameters for the headDocument operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<EmptyObject>>

  • Retrieve HTTP headers for a local document.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified local document. Since the +response body is empty, using the HEAD method is a lightweight way to check if the local document exists or not.

    +

    Parameters

    • params: HeadLocalDocumentParams

      The parameters to send to the service.

      +

      Parameters for the headLocalDocument operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a persistent replication.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified replication document from +the _replicator database. The method supports the same query arguments as the GET /_replicator/{doc_id} +method, but only headers like content length and the revision (ETag header) are returned.

    +

    Parameters

    • params: HeadReplicationDocumentParams

      The parameters to send to the service.

      +

      Parameters for the headReplicationDocument operation.

      +
      • docId: string

        Path parameter to specify the ID of the stored replication configuration in the _replicator database.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifNoneMatch?: string

        Header parameter for a conditional HTTP request not matching an ETag.

        +

    Returns Promise<Response<EmptyObject>>

  • Retrieve HTTP headers for a replication scheduler document.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified replication scheduler +document. Since the response body is empty, using the HEAD method is a lightweight way to check if the replication +scheduler document exists or not.

    +

    Parameters

    • params: HeadSchedulerDocumentParams

      The parameters to send to the service.

      +

      Parameters for the headSchedulerDocument operation.

      +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a replication scheduler job.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified replication task. Only +the header information is returned.

    +

    Parameters

    • params: HeadSchedulerJobParams

      The parameters to send to the service.

      +

      Parameters for the headSchedulerJob operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders
      • jobId: string

        Path parameter to specify the replication job id.

        +

    Returns Promise<Response<EmptyObject>>

  • Query a list of all documents in a database.

    +

    Queries the primary index (all document IDs). The results that match the request body parameters are returned in a +JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no +request body parameters are specified, results for all documents in the database are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    • params: PostAllDocsParams

      The parameters to send to the service.

      +

      Parameters for the postAllDocs operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Schema for a document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: string

        Schema for a document ID.

        +
      • Optionalkeys?: string[]

        Schema for a list of document IDs.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Schema for a document ID.

        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +

    Returns Promise<Response<CloudantV1.AllDocsResult>>

  • Query a list of all documents in a database as stream.

    +

    Queries the primary index (all document IDs). The results that match the request body parameters are returned in a +JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no +request body parameters are specified, results for all documents in the database are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    • params: PostAllDocsAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postAllDocsAsStream operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Schema for a document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: string

        Schema for a document ID.

        +
      • Optionalkeys?: string[]

        Schema for a list of document IDs.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Schema for a document ID.

        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +

    Returns Promise<Response<ReadableStream>>

  • Multi-query the list of all documents in a database.

    +

    Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of +result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This +enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

    +

    Parameters

    • params: PostAllDocsQueriesParams

      The parameters to send to the service.

      +

      Parameters for the postAllDocsQueries operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • queries: CloudantV1.AllDocsQuery[]

        An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

        +

    Returns Promise<Response<CloudantV1.AllDocsQueriesResult>>

  • Multi-query the list of all documents in a database as stream.

    +

    Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of +result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This +enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

    +

    Parameters

    • params: PostAllDocsQueriesAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postAllDocsQueriesAsStream operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • queries: CloudantV1.AllDocsQuery[]

        An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

        +

    Returns Promise<Response<ReadableStream>>

  • Generates API keys for apps or persons to enable database access.

    +

    Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant +account for that person or application. An API key is a randomly generated username and password. The key is given +the wanted access permissions for a database.

    +

    Parameters

    • Optionalparams: PostApiKeysParams

      The parameters to send to the service.

      +

      Parameters for the postApiKeys operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.ApiKeysResult>>

  • Bulk modify multiple documents in a database.

    +

    The bulk document API allows you to create, update, and delete multiple documents at the same time within a single +request. The basic operation is similar to creating, updating, or deleting a single document, except that you batch +the document structure and information.

    +

    Parameters

    • params: PostBulkDocsParams

      The parameters to send to the service.

      +

      Parameters for the postBulkDocs operation.

      +
      • bulkDocs: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.BulkDocs

        HTTP request body for postBulkDocs.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.DocumentResult[]>>

  • Bulk query revision information for multiple documents.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    • params: PostBulkGetParams

      The parameters to send to the service.

      +

      Parameters for the postBulkGet operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docs: CloudantV1.BulkGetQueryDocument[]

        List of document items to get in bulk.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +

    Returns Promise<Response<CloudantV1.BulkGetResult>>

  • Bulk query revision information for multiple documents as mixed.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    • params: PostBulkGetAsMixedParams

      The parameters to send to the service.

      +

      Parameters for the postBulkGetAsMixed operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docs: CloudantV1.BulkGetQueryDocument[]

        List of document items to get in bulk.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Bulk query revision information for multiple documents as related.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    • params: PostBulkGetAsRelatedParams

      The parameters to send to the service.

      +

      Parameters for the postBulkGetAsRelated operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docs: CloudantV1.BulkGetQueryDocument[]

        List of document items to get in bulk.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Bulk query revision information for multiple documents as stream.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    • params: PostBulkGetAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postBulkGetAsStream operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docs: CloudantV1.BulkGetQueryDocument[]

        List of document items to get in bulk.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallatest?: boolean

        Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

        +
      • Optionalrevs?: boolean

        Query parameter to specify whether to include a list of all known document revisions.

        +

    Returns Promise<Response<ReadableStream>>

  • Query the database document changes feed.

    +

    Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the +filter query parameter because it allows one to pass more information to the filter.

    +

    Before using the changes feed read the +FAQs to understand the limitations and +appropriate use cases.

    +

    If you need to pass parameters to dynamically change the filtered content use the _selector filter type for +better performance and compatibility. The SDKs have full support for change requests using selector filters, but +don't support passing parameters to design document filters.

    +

    Parameters

    • params: PostChangesParams

      The parameters to send to the service.

      +

      Parameters for the postChanges operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Query parameter to specify whether to return the documents in descending by key order.

        +
      • OptionaldocIds?: string[]

        Schema for a list of document IDs.

        +
      • Optionalfeed?: string

        Query parameter to specify the changes feed type.

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalfilter?: string

        Query parameter to specify a filter to emit only specific events from the changes stream.

        +

        The built-in filter types are:

        +
          +
        • _design - Returns only changes to design documents.
        • +
        • _doc_ids - Returns changes for documents with an ID matching one specified in +doc_ids request body parameter. (POST only)
        • +
        • _selector - Returns changes for documents that match the selector +request body parameter. The selector syntax is the same as used for +_find. (POST only)
        • +
        • _view - Returns changes for documents that match an existing map +function in the view specified by the query parameter view.
        • +
        +

        Additionally, the value can be the name of a JS filter function from a design document. For example: +design_doc/filtername.

        +

        Note: For better performance use the built-in _selector, _design or _doc_ids filters rather than JS +based _view or design document filters. If you need to pass values to change the filtered content use the +_selector filter type.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalheartbeat?: number

        Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

        +

        Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

        +
          +
        • Use the timeout parameter with a value that is compatible with your network environment.
        • +
        • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
        • +
        • Use TCP keepalive.
        • +
        +
      • OptionalincludeDocs?: boolean

        Query parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionallastEventId?: string

        Header parameter to specify the ID of the last events received by the server on a previous connection. +Overrides since query parameter.

        +
      • Optionallimit?: number

        Query parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalselector?: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • OptionalseqInterval?: number

        Query parameter to specify that the update seq should only be calculated with every Nth result returned. +When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> +is the number of results requested per batch, load can be reduced on the source database as computing the seq +value across many shards (especially in highly-sharded databases) is expensive.

        +
      • Optionalsince?: string

        Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

        +
      • Optionalstyle?: string

        Query parameter to specify how many revisions are returned in the changes array. The default, main_only, +will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts +and deleted former conflicts).

        +
      • Optionaltimeout?: number

        Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

        +
      • Optionalview?: string

        Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function +emits at least one record for them.

        +

    Returns Promise<Response<CloudantV1.ChangesResult>>

  • Query the database document changes feed as stream.

    +

    Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the +filter query parameter because it allows one to pass more information to the filter.

    +

    Before using the changes feed read the +FAQs to understand the limitations and +appropriate use cases.

    +

    If you need to pass parameters to dynamically change the filtered content use the _selector filter type for +better performance and compatibility. The SDKs have full support for change requests using selector filters, but +don't support passing parameters to design document filters.

    +

    Parameters

    • params: PostChangesAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postChangesAsStream operation.

      +
      • Optionalattachments?: boolean

        Query parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Query parameter to specify whether to return the documents in descending by key order.

        +
      • OptionaldocIds?: string[]

        Schema for a list of document IDs.

        +
      • Optionalfeed?: string

        Query parameter to specify the changes feed type.

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalfilter?: string

        Query parameter to specify a filter to emit only specific events from the changes stream.

        +

        The built-in filter types are:

        +
          +
        • _design - Returns only changes to design documents.
        • +
        • _doc_ids - Returns changes for documents with an ID matching one specified in +doc_ids request body parameter. (POST only)
        • +
        • _selector - Returns changes for documents that match the selector +request body parameter. The selector syntax is the same as used for +_find. (POST only)
        • +
        • _view - Returns changes for documents that match an existing map +function in the view specified by the query parameter view.
        • +
        +

        Additionally, the value can be the name of a JS filter function from a design document. For example: +design_doc/filtername.

        +

        Note: For better performance use the built-in _selector, _design or _doc_ids filters rather than JS +based _view or design document filters. If you need to pass values to change the filtered content use the +_selector filter type.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalheartbeat?: number

        Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

        +

        Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

        +
          +
        • Use the timeout parameter with a value that is compatible with your network environment.
        • +
        • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
        • +
        • Use TCP keepalive.
        • +
        +
      • OptionalincludeDocs?: boolean

        Query parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionallastEventId?: string

        Header parameter to specify the ID of the last events received by the server on a previous connection. +Overrides since query parameter.

        +
      • Optionallimit?: number

        Query parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalselector?: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • OptionalseqInterval?: number

        Query parameter to specify that the update seq should only be calculated with every Nth result returned. +When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> +is the number of results requested per batch, load can be reduced on the source database as computing the seq +value across many shards (especially in highly-sharded databases) is expensive.

        +
      • Optionalsince?: string

        Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

        +
      • Optionalstyle?: string

        Query parameter to specify how many revisions are returned in the changes array. The default, main_only, +will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts +and deleted former conflicts).

        +
      • Optionaltimeout?: number

        Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

        +
      • Optionalview?: string

        Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function +emits at least one record for them.

        +

    Returns Promise<Response<ReadableStream>>

  • Query information about multiple databases.

    +

    This operation enables you to request information about multiple databases in a single request, instead of issuing +multiple GET /{db} requests. It returns a list that contains an information object for each database specified in +the request.

    +

    Parameters

    • params: PostDbsInfoParams

      The parameters to send to the service.

      +

      Parameters for the postDbsInfo operation.

      +
      • Optionalheaders?: OutgoingHttpHeaders
      • keys: string[]

        A list of database names.

        +

    Returns Promise<Response<CloudantV1.DbsInfoResult[]>>

  • Query a list of all design documents in a database.

    +

    Queries the index of all design document IDs. The results matching the request body parameters are returned in a +JSON object, including a list of matching design documents with basic contents, such as the ID and revision. When +no request body parameters are specified, results for all design documents in the database are returned. +Optionally, the design document content or additional metadata can be included in the response.

    +

    Parameters

    • params: PostDesignDocsParams

      The parameters to send to the service.

      +

      Parameters for the postDesignDocs operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Schema for a document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: string

        Schema for a document ID.

        +
      • Optionalkeys?: string[]

        Schema for a list of document IDs.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Schema for a document ID.

        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +

    Returns Promise<Response<CloudantV1.AllDocsResult>>

  • Multi-query the list of all design documents.

    +

    This operation runs multiple view queries of all design documents in the database. This operation enables you to +request numerous queries in a single request, in place of multiple POST /{db}/_design_docs requests.

    +

    Parameters

    • params: PostDesignDocsQueriesParams

      The parameters to send to the service.

      +

      Parameters for the postDesignDocsQueries operation.

      +
      • Optionalaccept?: string

        The type of the response: application/json or application/octet-stream.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • queries: CloudantV1.AllDocsQuery[]

        An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

        +

    Returns Promise<Response<CloudantV1.AllDocsQueriesResult>>

  • Create or modify a document in a database.

    +

    Creates or modifies a document in the specified database by using the supplied JSON document.

    +

    For creation, you may specify the document ID but you should not specify the revision. If you don't specify the +document ID, then the server generates an ID for your document.

    +

    For modification, you must specify the document ID and a revision identifier in the JSON document.

    +

    If your document ID includes the _local/ or _design/ prefix, then this operation creates or modifies a local or +a design document respectively.

    +

    Parameters

    • params: PostDocumentParams

      The parameters to send to the service.

      +

      Parameters for the postDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • OptionalcontentType?: string

        The type of the input.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

        HTTP request body for Document operations.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Retrieve information about which index is used for a query.

    +

    Shows which index is being used by the query. Parameters are the same as the _find endpoint.

    +

    Parameters

    • params: PostExplainParams

      The parameters to send to the service.

      +

      Parameters for the postExplain operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • Optionalr?: number

        The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<CloudantV1.ExplainResult>>

  • Query an index by using selector syntax.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index by default fallback to using the built-in _all_docs index. This +isn't recommended because it has a significant performance impact causing a full scan of the database with each +request. In this case the response body includes a warning field recommending the creation of an index.

    +

    To avoid the fallback behavior set the allow_fallback option to false and the server responds with a 400 +status code if no suitable index exists. If you want to use only a specific index for your query set +allow_fallback to false and set the use_index option.

    +

    Parameters

    • params: PostFindParams

      The parameters to send to the service.

      +

      Parameters for the postFind operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • Optionalr?: number

        The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<CloudantV1.FindResult>>

  • Query an index by using selector syntax as stream.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index by default fallback to using the built-in _all_docs index. This +isn't recommended because it has a significant performance impact causing a full scan of the database with each +request. In this case the response body includes a warning field recommending the creation of an index.

    +

    To avoid the fallback behavior set the allow_fallback option to false and the server responds with a 400 +status code if no suitable index exists. If you want to use only a specific index for your query set +allow_fallback to false and set the use_index option.

    +

    Parameters

    • params: PostFindAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postFindAsStream operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • Optionalr?: number

        The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<ReadableStream>>

  • Create a new index on a database.

    +

    Create a new index on a database.

    +

    Parameters

    • params: PostIndexParams

      The parameters to send to the service.

      +

      Parameters for the postIndex operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalddoc?: string

        Specifies the design document name in which the index will be created. The design document name is the +design document ID excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • index: CloudantV1.IndexDefinition

        Schema for a json or text query index definition. Indexes of type text have additional configuration +properties that do not apply to json indexes, these are:

        +
          +
        • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all +document fields and what analyzer to use for that purpose.
        • +
        +
      • Optionalname?: string

        name.

        +
      • Optionalpartitioned?: boolean

        The default value is true for databases with partitioned: true and false otherwise. For databases with +partitioned: false if this option is specified the value must be false.

        +
      • Optionaltype?: string

        Schema for the type of an index.

        +

    Returns Promise<Response<CloudantV1.IndexResult>>

  • Query a list of all documents in a database partition.

    +

    Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON +object, including a list of matching documents with basic contents, such as the ID and revision. When no query +parameters are specified, results for all documents in the database partition are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    • params: PostPartitionAllDocsParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionAllDocs operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Schema for a document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: string

        Schema for a document ID.

        +
      • Optionalkeys?: string[]

        Schema for a list of document IDs.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Schema for a document ID.

        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +

    Returns Promise<Response<CloudantV1.AllDocsResult>>

  • Query a list of all documents in a database partition as stream.

    +

    Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON +object, including a list of matching documents with basic contents, such as the ID and revision. When no query +parameters are specified, results for all documents in the database partition are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    • params: PostPartitionAllDocsAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionAllDocsAsStream operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: string

        Schema for a document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: string

        Schema for a document ID.

        +
      • Optionalkeys?: string[]

        Schema for a list of document IDs.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: string

        Schema for a document ID.

        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +

    Returns Promise<Response<ReadableStream>>

  • Retrieve information about which partition index is used for a query.

    +

    Shows which index is being used by the query. Parameters are the same as the +/{db}/_partition/{partition_key}/_find endpoint.

    +

    Parameters

    • params: PostPartitionExplainParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionExplain operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<CloudantV1.ExplainResult>>

  • Query a database partition index by using selector syntax.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index by default fallback to using the built-in _all_docs index. This +isn't recommended because it has a significant performance impact causing a full scan of the partition with each +request. In this case the response body includes a warning field recommending the creation of an index.

    +

    To avoid the fallback behavior set the allow_fallback option to false and the server responds with a 400 +status code if no suitable index exists. If you want to use only a specific index for your query set +allow_fallback to false and set the use_index option.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionFindParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionFind operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<CloudantV1.FindResult>>

  • Query a database partition index by using selector syntax as stream.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index by default fallback to using the built-in _all_docs index. This +isn't recommended because it has a significant performance impact causing a full scan of the partition with each +request. In this case the response body includes a warning field recommending the creation of an index.

    +

    To avoid the fallback behavior set the allow_fallback option to false and the server responds with a 400 +status code if no suitable index exists. If you want to use only a specific index for your query set +allow_fallback to false and set the use_index option.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionFindAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionFindAsStream operation.

      +
      • OptionalallowFallback?: boolean

        Whether to allow fallback to other indexes. Default is true.

        +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalconflicts?: boolean

        A boolean value that indicates whether or not to include information about existing conflicts in the +document.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • OptionalexecutionStats?: boolean

        Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

        +
      • Optionalfields?: string[]

        JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionallimit?: number

        Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • selector: JsonObject

        JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

        +

        The selector object must:

        +
          +
        • Be structured as valid JSON.
        • +
        • Contain a valid query expression.
        • +
        +

        Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

        +

        Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

        +

        Operators are identified by the use of a dollar sign $ prefix in the name field.

        +

        There are two core types of operators in the selector syntax:

        +
          +
        • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
        • +
        • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
        • +
        +

        It is important for query performance to use appropriate selectors:

        +
          +
        • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
        • +
        • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
        • +
        +

        See the Cloudant Docsfor a list of all available +combination and conditional operators.

        +

        For further reference see selector syntax.

        +
      • Optionalskip?: number

        Skip the first 'n' results, where 'n' is the value that is specified.

        +
      • Optionalsort?: JsonObject[]

        The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

        +

        For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

        +

        When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

        +
      • Optionalstable?: boolean

        Whether or not the view results should be returned from a "stable" set of shards.

        +
      • Optionalupdate?: string

        Whether to update the index prior to returning the result.

        +
      • OptionaluseIndex?: string[]

        Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

        +

        It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

        +

        If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

        +

    Returns Promise<Response<ReadableStream>>

  • Query a database partition search index.

    +

    Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using +Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce +views. The index function decides what data to index and store in the index.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionSearchParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionSearch operation.

      +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalhighlightFields?: string[]

        Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

        +
      • OptionalhighlightNumber?: number

        Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

        +
      • OptionalhighlightPostTag?: string

        A string that is inserted after the highlighted word in the highlights output.

        +
      • OptionalhighlightPreTag?: string

        A string that is inserted before the highlighted word in the highlights output.

        +
      • OptionalhighlightSize?: number

        Number of characters in each fragment for highlights.

        +
      • OptionalincludeDocs?: boolean

        Include the full content of the documents in the return.

        +
      • OptionalincludeFields?: string[]

        A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

        +
      • index: string

        Path parameter to specify the index name.

        +
      • Optionallimit?: number

        Limit the number of the returned documents to the specified number.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • query: string

        The Lucene query to execute.

        +
      • Optionalsort?: string[]

        Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

        +
      • Optionalstale?: string

        Do not wait for the index to finish building to return results.

        +

    Returns Promise<Response<CloudantV1.SearchResult>>

  • Query a database partition search index as stream.

    +

    Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using +Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce +views. The index function decides what data to index and store in the index.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionSearchAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionSearchAsStream operation.

      +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalhighlightFields?: string[]

        Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

        +
      • OptionalhighlightNumber?: number

        Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

        +
      • OptionalhighlightPostTag?: string

        A string that is inserted after the highlighted word in the highlights output.

        +
      • OptionalhighlightPreTag?: string

        A string that is inserted before the highlighted word in the highlights output.

        +
      • OptionalhighlightSize?: number

        Number of characters in each fragment for highlights.

        +
      • OptionalincludeDocs?: boolean

        Include the full content of the documents in the return.

        +
      • OptionalincludeFields?: string[]

        A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

        +
      • index: string

        Path parameter to specify the index name.

        +
      • Optionallimit?: number

        Limit the number of the returned documents to the specified number.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • query: string

        The Lucene query to execute.

        +
      • Optionalsort?: string[]

        Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

        +
      • Optionalstale?: string

        Do not wait for the index to finish building to return results.

        +

    Returns Promise<Response<ReadableStream>>

  • Query a database partition MapReduce view function.

    +

    Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} +for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view +results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} +API.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionViewParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionView operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: any

        Schema for any JSON type.

        +
      • OptionalendKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalgroup?: boolean

        Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

        +
      • OptionalgroupLevel?: number

        Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: any

        Schema for any JSON type.

        +
      • Optionalkeys?: any[]

        Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • Optionalreduce?: boolean

        Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

        +

        A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

        +

        Be aware that include_docs=true can only be used with map views.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: any

        Schema for any JSON type.

        +
      • OptionalstartKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalupdate?: string

        Parameter to specify whether or not the view in question should be updated prior to responding to the user.

        +
          +
        • true - Return results after the view is updated.
        • +
        • false - Return results without updating the view.
        • +
        • lazy - Return the view results without waiting for an update, but update them immediately after the request.
        • +
        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<CloudantV1.ViewResult>>

  • Query a database partition MapReduce view function as stream.

    +

    Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} +for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view +results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} +API.

    +

    Before using read the +FAQs to understand +the limitations and appropriate use cases.

    +

    Parameters

    • params: PostPartitionViewAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postPartitionViewAsStream operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: any

        Schema for any JSON type.

        +
      • OptionalendKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalgroup?: boolean

        Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

        +
      • OptionalgroupLevel?: number

        Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: any

        Schema for any JSON type.

        +
      • Optionalkeys?: any[]

        Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • partitionKey: string

        Path parameter to specify the database partition key.

        +
      • Optionalreduce?: boolean

        Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

        +

        A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

        +

        Be aware that include_docs=true can only be used with map views.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • OptionalstartKey?: any

        Schema for any JSON type.

        +
      • OptionalstartKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalupdate?: string

        Parameter to specify whether or not the view in question should be updated prior to responding to the user.

        +
          +
        • true - Return results after the view is updated.
        • +
        • false - Return results without updating the view.
        • +
        • lazy - Return the view results without waiting for an update, but update them immediately after the request.
        • +
        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<ReadableStream>>

  • Create a persistent replication with a generated ID.

    +

    Creates or modifies a document in the _replicator database to start a new replication or to edit an existing +replication.

    +

    Parameters

    • params: PostReplicatorParams

      The parameters to send to the service.

      +

      Parameters for the postReplicator operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • replicationDocument: CloudantV1.ReplicationDocument

        HTTP request body for replication operations.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Query the document revisions and possible ancestors missing from the database.

    +

    The replicator is the primary user of this operation. After receiving a set of new revision IDs from the source +database, the replicator sends this set to the destination database's _revs_diff to find out which of them +already exists there. It can then avoid fetching and sending already-known document bodies.

    +

    Parameters

    • params: PostRevsDiffParams

      The parameters to send to the service.

      +

      Parameters for the postRevsDiff operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • documentRevisions: JsonObject

        HTTP request body for operations with Document revisions.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<JsonObject>>

  • Query a search index.

    +

    Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser +Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function +decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is +that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query +options as URL query parameters of a GET request.

    +

    Parameters

    • params: PostSearchParams

      The parameters to send to the service.

      +

      Parameters for the postSearch operation.

      +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalcounts?: string[]

        This field defines an array of names of string fields, for which counts are requested. The response contains +counts for each unique value of this field name among the documents that match the search query. Faceting must +be enabled for this parameter to function. This option is only available when making global queries.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldrilldown?: string[][]

        Restrict results to documents with a dimension equal to the specified label(s). The search matches only +documents containing the value that was provided in the named field. It differs from using "fieldname:value" in +the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to +function.

        +
      • OptionalgroupField?: string

        Field by which to group search matches. A string that contains the name of a string field. Fields containing +other data such as numbers, objects, or arrays cannot be used. This option is only available when making global +queries.

        +
      • OptionalgroupLimit?: number

        Maximum group count. This field can be used only if group_field is specified. This option is only available +when making global queries.

        +
      • OptionalgroupSort?: string[]

        This field defines the order of the groups in a search that uses group_field. The default sort order is +relevance. This field can have the same values as the sort field, so single fields and arrays of fields are +supported. This option is only available when making global queries.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalhighlightFields?: string[]

        Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

        +
      • OptionalhighlightNumber?: number

        Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

        +
      • OptionalhighlightPostTag?: string

        A string that is inserted after the highlighted word in the highlights output.

        +
      • OptionalhighlightPreTag?: string

        A string that is inserted before the highlighted word in the highlights output.

        +
      • OptionalhighlightSize?: number

        Number of characters in each fragment for highlights.

        +
      • OptionalincludeDocs?: boolean

        Include the full content of the documents in the return.

        +
      • OptionalincludeFields?: string[]

        A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

        +
      • index: string

        Path parameter to specify the index name.

        +
      • Optionallimit?: number

        Limit the number of the returned documents to the specified number.

        +
      • query: string

        The Lucene query to execute.

        +
      • Optionalranges?: JsonObject

        Object mapping faceted, numeric search field names to the required ranges. Each key is a field name and each +value is another object defining the ranges by mapping range name keys to string values describing the numeric +ranges, for example "[0 TO 10]". This option is only available when making global queries.

        +
      • Optionalsort?: string[]

        Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

        +
      • Optionalstale?: string

        Do not wait for the index to finish building to return results.

        +

    Returns Promise<Response<CloudantV1.SearchResult>>

  • Query a search index as stream.

    +

    Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser +Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function +decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is +that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query +options as URL query parameters of a GET request.

    +

    Parameters

    • params: PostSearchAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postSearchAsStream operation.

      +
      • Optionalbookmark?: string

        Opaque bookmark token used when paginating results.

        +
      • Optionalcounts?: string[]

        This field defines an array of names of string fields, for which counts are requested. The response contains +counts for each unique value of this field name among the documents that match the search query. Faceting must +be enabled for this parameter to function. This option is only available when making global queries.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldrilldown?: string[][]

        Restrict results to documents with a dimension equal to the specified label(s). The search matches only +documents containing the value that was provided in the named field. It differs from using "fieldname:value" in +the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to +function.

        +
      • OptionalgroupField?: string

        Field by which to group search matches. A string that contains the name of a string field. Fields containing +other data such as numbers, objects, or arrays cannot be used. This option is only available when making global +queries.

        +
      • OptionalgroupLimit?: number

        Maximum group count. This field can be used only if group_field is specified. This option is only available +when making global queries.

        +
      • OptionalgroupSort?: string[]

        This field defines the order of the groups in a search that uses group_field. The default sort order is +relevance. This field can have the same values as the sort field, so single fields and arrays of fields are +supported. This option is only available when making global queries.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalhighlightFields?: string[]

        Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

        +
      • OptionalhighlightNumber?: number

        Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

        +
      • OptionalhighlightPostTag?: string

        A string that is inserted after the highlighted word in the highlights output.

        +
      • OptionalhighlightPreTag?: string

        A string that is inserted before the highlighted word in the highlights output.

        +
      • OptionalhighlightSize?: number

        Number of characters in each fragment for highlights.

        +
      • OptionalincludeDocs?: boolean

        Include the full content of the documents in the return.

        +
      • OptionalincludeFields?: string[]

        A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

        +
      • index: string

        Path parameter to specify the index name.

        +
      • Optionallimit?: number

        Limit the number of the returned documents to the specified number.

        +
      • query: string

        The Lucene query to execute.

        +
      • Optionalranges?: JsonObject

        Object mapping faceted, numeric search field names to the required ranges. Each key is a field name and each +value is another object defining the ranges by mapping range name keys to string values describing the numeric +ranges, for example "[0 TO 10]". This option is only available when making global queries.

        +
      • Optionalsort?: string[]

        Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

        +
      • Optionalstale?: string

        Do not wait for the index to finish building to return results.

        +

    Returns Promise<Response<ReadableStream>>

  • Query a MapReduce view.

    +

    This operation queries the specified MapReduce view of the specified design document. By default, the map and +reduce functions of the view are run to update the view before returning the response. The advantage of using the +HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations +of passing query options as URL query parameters of a GET request.

    +

    Parameters

    • params: PostViewParams

      The parameters to send to the service.

      +

      Parameters for the postView operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: any

        Schema for any JSON type.

        +
      • OptionalendKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalgroup?: boolean

        Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

        +
      • OptionalgroupLevel?: number

        Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: any

        Schema for any JSON type.

        +
      • Optionalkeys?: any[]

        Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalreduce?: boolean

        Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

        +

        A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

        +

        Be aware that include_docs=true can only be used with map views.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • Optionalstable?: boolean

        Query parameter to specify whether use the same replica of the index on each request. The default value +false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true +when used in conjunction with update=false may improve consistency at the expense of increased latency and +decreased throughput if the selected replica is not the fastest of the available replicas.

        +

        Note: In general setting true is discouraged and is strictly not recommended when using update=true.

        +
      • OptionalstartKey?: any

        Schema for any JSON type.

        +
      • OptionalstartKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalupdate?: string

        Parameter to specify whether or not the view in question should be updated prior to responding to the user.

        +
          +
        • true - Return results after the view is updated.
        • +
        • false - Return results without updating the view.
        • +
        • lazy - Return the view results without waiting for an update, but update them immediately after the request.
        • +
        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<CloudantV1.ViewResult>>

  • Query a MapReduce view as stream.

    +

    This operation queries the specified MapReduce view of the specified design document. By default, the map and +reduce functions of the view are run to update the view before returning the response. The advantage of using the +HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations +of passing query options as URL query parameters of a GET request.

    +

    Parameters

    • params: PostViewAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postViewAsStream operation.

      +
      • Optionalattachments?: boolean

        Parameter to specify whether to include attachments bodies in a response.

        +
      • OptionalattEncodingInfo?: boolean

        Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

        +
      • Optionalconflicts?: boolean

        Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionaldescending?: boolean

        Parameter to specify whether to return the documents in descending by key order.

        +
      • OptionalendKey?: any

        Schema for any JSON type.

        +
      • OptionalendKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalgroup?: boolean

        Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

        +
      • OptionalgroupLevel?: number

        Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalincludeDocs?: boolean

        Parameter to specify whether to include the full content of the documents in the response.

        +
      • OptionalinclusiveEnd?: boolean

        Parameter to specify whether the specified end key should be included in the result.

        +
      • Optionalkey?: any

        Schema for any JSON type.

        +
      • Optionalkeys?: any[]

        Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

        +
      • Optionallimit?: number

        Parameter to specify the number of returned documents to limit the result to.

        +
      • Optionalreduce?: boolean

        Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

        +

        A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

        +

        Be aware that include_docs=true can only be used with map views.

        +
      • Optionalskip?: number

        Parameter to specify the number of records before starting to return the results.

        +
      • Optionalstable?: boolean

        Query parameter to specify whether use the same replica of the index on each request. The default value +false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true +when used in conjunction with update=false may improve consistency at the expense of increased latency and +decreased throughput if the selected replica is not the fastest of the available replicas.

        +

        Note: In general setting true is discouraged and is strictly not recommended when using update=true.

        +
      • OptionalstartKey?: any

        Schema for any JSON type.

        +
      • OptionalstartKeyDocId?: string

        Schema for a document ID.

        +
      • Optionalupdate?: string

        Parameter to specify whether or not the view in question should be updated prior to responding to the user.

        +
          +
        • true - Return results after the view is updated.
        • +
        • false - Return results without updating the view.
        • +
        • lazy - Return the view results without waiting for an update, but update them immediately after the request.
        • +
        +
      • OptionalupdateSeq?: boolean

        Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<ReadableStream>>

  • Multi-query a MapReduce view.

    +

    This operation runs multiple specified view queries against the view function from the specified design document.

    +

    Parameters

    • params: PostViewQueriesParams

      The parameters to send to the service.

      +

      Parameters for the postViewQueries operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • queries: CloudantV1.ViewQuery[]

        An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular view request.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<CloudantV1.ViewQueriesResult>>

  • Multi-query a MapReduce view as stream.

    +

    This operation runs multiple specified view queries against the view function from the specified design document.

    +

    Parameters

    • params: PostViewQueriesAsStreamParams

      The parameters to send to the service.

      +

      Parameters for the postViewQueriesAsStream operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • queries: CloudantV1.ViewQuery[]

        An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular view request.

        +
      • view: string

        Path parameter to specify the map reduce view function name.

        +

    Returns Promise<Response<ReadableStream>>

  • Create or modify an attachment.

    +

    Uploads the supplied content as an attachment to the specified document. The attachment name that you provide must +be a URL encoded string. You must supply the Content-Type header, and for an existing document, you must also +supply either the rev query argument or the If-Match HTTP header. If you omit the revision, a new, otherwise +empty, document is created with the provided attachment, or a conflict occurs. If the uploaded attachment uses an +existing attachment name in the remote database, it updates the corresponding stored content of the database. Since +you must supply the revision information to add an attachment to the document, this serves as validation to update +the existing attachment.

    +

    Parameters

    • params: PutAttachmentParams

      The parameters to send to the service.

      +

      Parameters for the putAttachment operation.

      +
      • attachment: Buffer<ArrayBufferLike> | ReadableStream

        HTTP request body for attachment operations.

        +
      • attachmentName: string

        Path parameter to specify the attachment name.

        +
      • contentType: string

        Content-Type of the attachment.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Modify only Cloudant related database permissions.

    +

    Modify only Cloudant related permissions to database. Be careful: by removing an API key from the list, you remove +the API key from the list of users that have access to the database.

    +

    The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to +read data from a database, but did not identify itself, the task can continue only if the nobody user has the +role _reader.

    +

    Parameters

    • params: PutCloudantSecurityConfigurationParams

      The parameters to send to the service.

      +

      Parameters for the putCloudantSecurityConfiguration operation.

      +
      • Optionaladmins?: CloudantV1.SecurityObject

        Schema for names and roles to map to a database permission.

        +
      • cloudant: JsonObject

        Database permissions for Cloudant users and/or API keys.

        +
      • OptionalcouchdbAuthOnly?: boolean

        Manage permissions using the _users database only.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalmembers?: CloudantV1.SecurityObject

        Schema for names and roles to map to a database permission.

        +

    Returns Promise<Response<CloudantV1.Ok>>

  • Modify CORS configuration.

    +

    Sets the CORS configuration. The configuration applies to all databases and all account level endpoints in your +account.

    +

    Parameters

    • params: PutCorsConfigurationParams

      The parameters to send to the service.

      +

      Parameters for the putCorsConfiguration operation.

      +
      • OptionalallowCredentials?: boolean

        Boolean value to allow authentication credentials. If set to true, browser requests must be done by using +withCredentials = true.

        +
      • OptionalenableCors?: boolean

        Boolean value to turn CORS on and off.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • origins: string[]

        An array of strings that contain allowed origin domains. You have to specify the full URL including the +protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you +have to specify all subdomains used.

        +

    Returns Promise<Response<CloudantV1.Ok>>

  • Create a database.

    +

    Create a new database with the requested properties.

    +

    Parameters

    • params: PutDatabaseParams

      The parameters to send to the service.

      +

      Parameters for the putDatabase operation.

      +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalpartitioned?: boolean

        Query parameter to specify whether to enable database partitions when creating a database.

        +

        Before using read the +FAQs +to understand the limitations and appropriate use cases.

        +
      • Optionalq?: number

        The number of shards in the database. Each shard is a partition of the hash value range. Cloudant recommends +using the default value for most databases. However, if your database is expected to be larger than 250 GB or +have a lot of indexes, you may need to adjust the settings. In these cases, it's best to reach out to IBM +Cloudant customer support for guidance on how to meet your specific needs and requirements.

        +

    Returns Promise<Response<CloudantV1.Ok>>

  • Create or modify a design document.

    +

    The PUT method creates a new named design document, or creates a new revision of the existing design document.

    +

    Parameters

    • params: PutDesignDocumentParams

      The parameters to send to the service.

      +

      Parameters for the putDesignDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • ddoc: string

        Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

        +
      • designDocument: CloudantV1.DesignDocument

        HTTP request body for DesignDocument operations.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • OptionalnewEdits?: boolean

        Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

        +

        Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Create or modify a document.

    +

    Creates or modifies a document in the specified database.

    +

    For creation, you must specify the document ID but you should not specify the revision.

    +

    For modification, you must specify the document ID and a revision identifier.

    +

    Parameters

    • params: PutDocumentParams

      The parameters to send to the service.

      +

      Parameters for the putDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • OptionalcontentType?: string

        The type of the input.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

        HTTP request body for Document operations.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • OptionalnewEdits?: boolean

        Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

        +

        Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Create or modify a local document.

    +

    Stores the specified local document. The semantics are identical to storing a standard document in the specified +database, except that the document is not replicated.

    +

    Parameters

    • params: PutLocalDocumentParams

      The parameters to send to the service.

      +

      Parameters for the putLocalDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • OptionalcontentType?: string

        The type of the input.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • docId: string

        Path parameter to specify the document ID.

        +
      • document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

        HTTP request body for Document operations.

        +
      • Optionalheaders?: OutgoingHttpHeaders

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Create or modify a persistent replication.

    +

    Creates or modifies a document in the _replicator database to start a new replication or to edit an existing +replication.

    +

    Parameters

    • params: PutReplicationDocumentParams

      The parameters to send to the service.

      +

      Parameters for the putReplicationDocument operation.

      +
      • Optionalbatch?: string

        Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

        +
      • docId: string

        Path parameter to specify the ID of the stored replication configuration in the _replicator database.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalifMatch?: string

        Header parameter for a conditional HTTP request matching an ETag.

        +
      • OptionalnewEdits?: boolean

        Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

        +

        Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

        +
      • replicationDocument: CloudantV1.ReplicationDocument

        HTTP request body for replication operations.

        +
      • Optionalrev?: string

        Query parameter to specify a document revision.

        +

    Returns Promise<Response<CloudantV1.DocumentResult>>

  • Modify database permissions.

    +

    Modify who has permission to read, write, or manage a database. This endpoint can be used to modify both Cloudant +and CouchDB related permissions. Be careful: by removing a Cloudant API key, a member or an admin from the list of +users that have access permissions, you remove it from the list of users that have access to the database.

    +

    The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to +read data from a database, but did not identify itself, the task can continue only if the nobody user has the +role _reader.

    +

    Parameters

    • params: PutSecurityParams

      The parameters to send to the service.

      +

      Parameters for the putSecurity operation.

      +
      • Optionaladmins?: CloudantV1.SecurityObject

        Schema for names and roles to map to a database permission.

        +
      • Optionalcloudant?: JsonObject

        Database permissions for Cloudant users and/or API keys.

        +
      • OptionalcouchdbAuthOnly?: boolean

        Manage permissions using the _users database only.

        +
      • db: string

        Path parameter to specify the database name.

        +
      • Optionalheaders?: OutgoingHttpHeaders
      • Optionalmembers?: CloudantV1.SecurityObject

        Schema for names and roles to map to a database permission.

        +

    Returns Promise<Response<CloudantV1.Ok>>

  • Turn request body compression on or off. +Cloudant specific extensions:

    +
      +
    • Apply the gzip compression option on CouchdbSessionAuthenticator.
    • +
    +

    Parameters

    • setting: boolean

      Will turn it on if 'true', off if 'false'.

      +

    Returns void

  • Set the service URL to send requests to and +use the new service URL for CouchDB Session Authentication +to claim session token from.

    +

    Parameters

    • url: string

      The base URL for the service.

      +

    Returns void

  • Constructs an instance of CloudantV1 with passed in options and external configuration.

    +

    Parameters

    • Optionaloptions: UserOptions

      The parameters to send to the service.

      +
      • serviceName

        The name of the service to configure

        +
      • authenticator

        The Authenticator object used to authenticate requests to the service

        +
      • serviceUrl

        The base URL for the service

        +

    Returns CloudantV1

diff --git a/docs/0.12.1/classes/CloudantV1.ActiveTask-1.html b/docs/0.12.1/classes/CloudantV1.ActiveTask-1.html new file mode 100644 index 000000000..0164af6d7 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ActiveTask-1.html @@ -0,0 +1,81 @@ +ActiveTask | @ibm-cloud/cloudant - v0.12.1

Schema for information about a running task.

+

Constructors

Properties

bulkGetAttempts?: number

The total count of attempted doc revisions fetched with _bulk_get. Available for replication type tasks.

+
bulkGetDocs?: number

The total count of successful docs fetched with _bulk_get. Available for replication type tasks.

+
changesDone?: number

Processed changes. Available for database_compaction, indexer, search_indexer, view_compaction type +tasks.

+
changesPending?: number

The count of changes not yet replicated. Available for replication type tasks.

+
checkpointedSourceSeq?: string

The source sequence id which was last successfully replicated. Available for replication type tasks.

+
checkpointInterval?: number

Specifies the checkpoint interval in ms. Available for replication type tasks.

+
continuous?: boolean

The replication configured to be continuous. Available for replication type tasks.

+
database: string

Source database.

+
designDocument?: string

The design document that belongs to this task. Available for indexer, search_indexer, view_compaction +type tasks.

+
docId?: string

Replication document ID. Available for replication type tasks.

+
docsRead?: number

Number of documents read. Available for replication type tasks.

+
docsWritten?: number

Number of documents written to target. Available for replication type tasks.

+
docWriteFailures?: number

Number of document write failures. Available for replication type tasks.

+
index?: string

The search index that belongs to this task. Available for search_indexer type tasks.

+
indexerPid?: string

Indexer process ID. Available for indexer type tasks.

+
missingRevisionsFound?: number

The count of docs which have been read from the source. Available for replication type tasks.

+
node: string

Cluster node where the task is running.

+
phase?: string

The phase the active task is in. docid_sort, docid_copy, document_copy phases are available for +database_compaction, while ids and view phases are available for view_compaction type tasks.

+
pid: string

Process ID.

+
processStatus?: string

Process status.

+
progress?: number

Current percentage progress. Available for database_compaction, indexer, search_indexer, +view_compaction type tasks.

+
replicationId?: string

Replication ID. Available for replication type tasks.

+
retry?: boolean

Indicates whether a compaction retry is currently running on the database. Available for +database_compaction type tasks.

+
revisionsChecked?: number

The count of revisions which have been checked since this replication began. Available for replication +type tasks.

+
source?: string

Replication source. Available for replication type tasks.

+
sourceSeq?: string

The last sequence number obtained from the source database changes feed. Available for replication type +tasks.

+
startedOn: number

Schema for a Unix epoch timestamp.

+
target?: string

Replication target. Available for replication type tasks.

+
throughSeq?: string

The last sequence number processed by the replicator. Available for replication type tasks.

+
totalChanges?: number

Total changes to process. Available for database_compaction, indexer, search_indexer, +view_compaction type tasks.

+
type: string

Operation type.

+
updatedOn: number

Schema for a Unix epoch timestamp.

+
user?: string

Name of user running the process.

+
view?: number

Number of view indexes. Available for view_compaction type tasks.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ActivityTrackerEvents-1.html b/docs/0.12.1/classes/CloudantV1.ActivityTrackerEvents-1.html new file mode 100644 index 000000000..0e7351bd2 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ActivityTrackerEvents-1.html @@ -0,0 +1,8 @@ +ActivityTrackerEvents | @ibm-cloud/cloudant - v0.12.1

Schema for Activity Tracker events.

+

Constructors

Properties

Methods

Constructors

Properties

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. +"management" is a required element of this array.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.AllDocsQueriesResult-1.html b/docs/0.12.1/classes/CloudantV1.AllDocsQueriesResult-1.html new file mode 100644 index 000000000..90ef49443 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.AllDocsQueriesResult-1.html @@ -0,0 +1,8 @@ +AllDocsQueriesResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of an all documents queries operation.

+

Constructors

Properties

Methods

Constructors

Properties

An array of result objects - one for each query. Each result object contains the same fields as the response +to a regular /_all_docs request.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.AllDocsQuery-1.html b/docs/0.12.1/classes/CloudantV1.AllDocsQuery-1.html new file mode 100644 index 000000000..4309fdac5 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.AllDocsQuery-1.html @@ -0,0 +1,34 @@ +AllDocsQuery | @ibm-cloud/cloudant - v0.12.1

Schema for an all documents query operation.

+

Constructors

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.AllDocsResult-1.html b/docs/0.12.1/classes/CloudantV1.AllDocsResult-1.html new file mode 100644 index 000000000..ec40f0a35 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.AllDocsResult-1.html @@ -0,0 +1,11 @@ +AllDocsResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of an all documents operation.

+

Constructors

Properties

Methods

Constructors

Properties

List of doc results.

+
totalRows: number

Total number of document results.

+
updateSeq?: string

Current update sequence for the database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Analyzer-1.html b/docs/0.12.1/classes/CloudantV1.Analyzer-1.html new file mode 100644 index 000000000..54927f42c --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Analyzer-1.html @@ -0,0 +1,14 @@ +Analyzer | @ibm-cloud/cloudant - v0.12.1

Schema for a full text search analyzer.

+

Constructors

Properties

Methods

Constructors

Properties

name: string

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies +depending on the analyzer usage:

+
    +
  • For search indexes the default is standard * For query text indexes the default is keyword * For a query +text index default_field the default is standard.
  • +
+
stopwords?: string[]

Custom stopwords to use with the named analyzer.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.AnalyzerConfiguration-1.html b/docs/0.12.1/classes/CloudantV1.AnalyzerConfiguration-1.html new file mode 100644 index 000000000..72ba97a0b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.AnalyzerConfiguration-1.html @@ -0,0 +1,16 @@ +AnalyzerConfiguration | @ibm-cloud/cloudant - v0.12.1

Schema for a search analyzer configuration.

+

Constructors

Properties

Methods

Constructors

Properties

fields?: { [key: string]: CloudantV1.Analyzer }

Schema for mapping a field name to a per field analyzer.

+
name: string

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies +depending on the analyzer usage:

+
    +
  • For search indexes the default is standard * For query text indexes the default is keyword * For a query +text index default_field the default is standard.
  • +
+
stopwords?: string[]

Custom stopwords to use with the named analyzer.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ApiKeysResult-1.html b/docs/0.12.1/classes/CloudantV1.ApiKeysResult-1.html new file mode 100644 index 000000000..acfbeb80f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ApiKeysResult-1.html @@ -0,0 +1,11 @@ +ApiKeysResult | @ibm-cloud/cloudant - v0.12.1

Schema for api keys.

+

Constructors

Properties

Methods

Constructors

Properties

key: string

The generated api key.

+
ok: boolean

ok.

+
password: string

The password associated with the api key.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Attachment-1.html b/docs/0.12.1/classes/CloudantV1.Attachment-1.html new file mode 100644 index 000000000..51034ed2b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Attachment-1.html @@ -0,0 +1,30 @@ +Attachment | @ibm-cloud/cloudant - v0.12.1

Schema for an attachment.

+

Constructors

Properties

contentType?: string

Attachment MIME type.

+
data?: Buffer

Base64-encoded content. Available if attachment content is requested by using the query parameters +attachments=true or atts_since. Note that when used with a view or changes feed include_docs must also be +true.

+
digest?: string

Content hash digest. It starts with prefix which announce hash type (e.g. md5-) and continues with +Base64-encoded hash digest.

+
encodedLength?: number

Compressed attachment size in bytes. Available if content_type was in list of compressible types when the +attachment was added and the query parameter att_encoding_info is true. Note that when used with a view or +changes feed include_docs must also be true.

+
encoding?: string

Compression codec. Available if content_type was in list of compressible types when the attachment was added +and the and the query parameter att_encoding_info is true. Note that when used with a view or changes feed +include_docs must also be true.

+
follows?: boolean

True if the attachment follows in a multipart request or response.

+
length?: number

Real attachment size in bytes. Not available if inline attachment content requested.

+
revpos?: number

Revision number when attachment was added.

+
stub?: boolean

Has true value if object contains stub info and no content. Otherwise omitted in response.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.BulkDocs-1.html b/docs/0.12.1/classes/CloudantV1.BulkDocs-1.html new file mode 100644 index 000000000..30d4d3b0d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.BulkDocs-1.html @@ -0,0 +1,11 @@ +BulkDocs | @ibm-cloud/cloudant - v0.12.1

Schema for submitting documents for bulk modifications.

+

Constructors

Properties

Methods

Constructors

Properties

Array of documents.

+
newEdits?: boolean

If false, prevents the database from assigning them new revision IDs. Default is true.

+

Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.BulkGetQueryDocument-1.html b/docs/0.12.1/classes/CloudantV1.BulkGetQueryDocument-1.html new file mode 100644 index 000000000..87711dd31 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.BulkGetQueryDocument-1.html @@ -0,0 +1,11 @@ +BulkGetQueryDocument | @ibm-cloud/cloudant - v0.12.1

Schema for a document item in a bulk get query.

+

Constructors

Properties

Methods

Constructors

Properties

attsSince?: string[]

Includes attachments only since specified revisions.

+
id: string

Schema for a document ID.

+
rev?: string

Schema for a document revision identifier.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.BulkGetResult-1.html b/docs/0.12.1/classes/CloudantV1.BulkGetResult-1.html new file mode 100644 index 000000000..a9d67031d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.BulkGetResult-1.html @@ -0,0 +1,7 @@ +BulkGetResult | @ibm-cloud/cloudant - v0.12.1

Schema for the results object of a bulk get operation.

+

Constructors

Properties

Methods

Constructors

Properties

Results.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.BulkGetResultDocument-1.html b/docs/0.12.1/classes/CloudantV1.BulkGetResultDocument-1.html new file mode 100644 index 000000000..88b4abbec --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.BulkGetResultDocument-1.html @@ -0,0 +1,9 @@ +BulkGetResultDocument | @ibm-cloud/cloudant - v0.12.1

Schema for BulkGetResult object containing a successfully retrieved document or error information.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for the result of a document modification.

+

Schema for a document.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.BulkGetResultItem-1.html b/docs/0.12.1/classes/CloudantV1.BulkGetResultItem-1.html new file mode 100644 index 000000000..e5e0d2d9b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.BulkGetResultItem-1.html @@ -0,0 +1,9 @@ +BulkGetResultItem | @ibm-cloud/cloudant - v0.12.1

Schema for the document revisions information from a bulk get operation.

+

Constructors

Properties

docs +id +

Methods

Constructors

Properties

Array of document revisions or error information.

+
id: string

Schema for a document ID.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformation-1.html b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformation-1.html new file mode 100644 index 000000000..1fe3779ab --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformation-1.html @@ -0,0 +1,9 @@ +CapacityThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about the currently provisioned and target throughput capacity.

+

Constructors

Properties

Methods

Constructors

Properties

Detailed information about provisioned throughput capacity.

+

Detailed information about target throughput capacity.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationCurrent-1.html b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationCurrent-1.html new file mode 100644 index 000000000..003fbdd1d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationCurrent-1.html @@ -0,0 +1,8 @@ +CapacityThroughputInformationCurrent | @ibm-cloud/cloudant - v0.12.1

Detailed information about provisioned throughput capacity.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for detailed information about throughput capacity with breakdown by specific throughput requests +classes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationTarget-1.html b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationTarget-1.html new file mode 100644 index 000000000..be8f714b6 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CapacityThroughputInformationTarget-1.html @@ -0,0 +1,8 @@ +CapacityThroughputInformationTarget | @ibm-cloud/cloudant - v0.12.1

Detailed information about target throughput capacity.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for detailed information about throughput capacity with breakdown by specific throughput requests +classes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Change-1.html b/docs/0.12.1/classes/CloudantV1.Change-1.html new file mode 100644 index 000000000..4f6591ecd --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Change-1.html @@ -0,0 +1,7 @@ +Change | @ibm-cloud/cloudant - v0.12.1

Schema for a document leaf with single field rev.

+

Constructors

Properties

rev +

Methods

Constructors

Properties

rev: string

Schema for a document revision identifier.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ChangesResult-1.html b/docs/0.12.1/classes/CloudantV1.ChangesResult-1.html new file mode 100644 index 000000000..e3764cae7 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ChangesResult-1.html @@ -0,0 +1,11 @@ +ChangesResult | @ibm-cloud/cloudant - v0.12.1

Schema for normal changes feed result.

+

Constructors

Properties

Methods

Constructors

Properties

lastSeq: string

last_seq.

+
pending: number

pending.

+

results.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ChangesResultItem-1.html b/docs/0.12.1/classes/CloudantV1.ChangesResultItem-1.html new file mode 100644 index 000000000..507d2785d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ChangesResultItem-1.html @@ -0,0 +1,15 @@ +ChangesResultItem | @ibm-cloud/cloudant - v0.12.1

Schema for an item in the changes results array.

+

Constructors

Properties

Methods

Constructors

Properties

changes: CloudantV1.Change[]

List of document's leaves with single field rev.

+
deleted?: boolean

if true then the document is deleted.

+

Schema for a document.

+
id: string

Schema for a document ID.

+
seq: string

Update sequence.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ContentInformationSizes-1.html b/docs/0.12.1/classes/CloudantV1.ContentInformationSizes-1.html new file mode 100644 index 000000000..593ee79fa --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ContentInformationSizes-1.html @@ -0,0 +1,11 @@ +ContentInformationSizes | @ibm-cloud/cloudant - v0.12.1

Schema for size information of content.

+

Constructors

Properties

Methods

Constructors

Properties

active: number

The active size of the content, in bytes.

+
external: number

The total uncompressed size of the content, in bytes.

+
file: number

The total size of the content as stored on disk, in bytes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CorsInformation-1.html b/docs/0.12.1/classes/CloudantV1.CorsInformation-1.html new file mode 100644 index 000000000..85fc9a495 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CorsInformation-1.html @@ -0,0 +1,14 @@ +CorsInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about the CORS configuration.

+

Constructors

Properties

allowCredentials: boolean

Boolean value to allow authentication credentials. If set to true, browser requests must be done by using +withCredentials = true.

+
enableCors: boolean

Boolean value to turn CORS on and off.

+
origins: string[]

An array of strings that contain allowed origin domains. You have to specify the full URL including the +protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you +have to specify all subdomains used.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformation-1.html b/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformation-1.html new file mode 100644 index 000000000..d1d62a98b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformation-1.html @@ -0,0 +1,7 @@ +CurrentThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about current consumption of a provisioned throughput capacity.

+

Constructors

Properties

Methods

Constructors

Properties

Detailed information about current consumption.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformationThroughput-1.html b/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformationThroughput-1.html new file mode 100644 index 000000000..60d632edc --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.CurrentThroughputInformationThroughput-1.html @@ -0,0 +1,11 @@ +CurrentThroughputInformationThroughput | @ibm-cloud/cloudant - v0.12.1

Detailed information about current consumption.

+

Constructors

Properties

Methods

Constructors

Properties

query: number

Number of global queries conducted against the instance for a given second.

+
read: number

Number of reads conducted against the instance for a given second.

+
write: number

Number of writes conducted against the instance for a given second.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DatabaseInformation-1.html b/docs/0.12.1/classes/CloudantV1.DatabaseInformation-1.html new file mode 100644 index 000000000..7ffb915dc --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DatabaseInformation-1.html @@ -0,0 +1,37 @@ +DatabaseInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about a database.

+

Constructors

Properties

Schema for database cluster information.

+
committedUpdateSeq?: string

An opaque string that describes the committed state of the database.

+
compactedSeq?: string

An opaque string that describes the compaction state of the database.

+
compactRunning: boolean

True if the database compaction routine is operating on this database.

+
dbName: string

Schema for a database name.

+
diskFormatVersion: number

The version of the physical format used for the data when it is stored on disk.

+
docCount: number

A count of the documents in the specified database.

+
docDelCount: number

Number of deleted documents.

+
engine?: string

The engine used for the database.

+
instanceStartTime: string

An opaque string to detect whether a database has been recreated. The field name is for compatibility with +old replicator versions. Do not use the value to infer timing infromation. Typically only used by replicators.

+

Information about database's partitioned indexes.

+

Schema for database properties.

+

Schema for size information of content.

+
updateSeq: string

An opaque string that describes the state of the database. Do not rely on this string for counting the +number of updates.

+
uuid?: string

The UUID of the database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DatabaseInformationCluster-1.html b/docs/0.12.1/classes/CloudantV1.DatabaseInformationCluster-1.html new file mode 100644 index 000000000..9465411fa --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DatabaseInformationCluster-1.html @@ -0,0 +1,14 @@ +DatabaseInformationCluster | @ibm-cloud/cloudant - v0.12.1

Schema for database cluster information.

+

Constructors

Properties

n +q +r +w +

Methods

Constructors

Properties

n: number

Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it +cannot be changed by the user.

+
q: number

Schema for the number of shards in a database. Each shard is a partition of the hash value range.

+
r: number

Read quorum. The number of consistent copies of a document that need to be read before a successful reply.

+
w: number

Write quorum. The number of copies of a document that need to be written before a successful reply.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DatabaseInformationProps-1.html b/docs/0.12.1/classes/CloudantV1.DatabaseInformationProps-1.html new file mode 100644 index 000000000..509208a64 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DatabaseInformationProps-1.html @@ -0,0 +1,7 @@ +DatabaseInformationProps | @ibm-cloud/cloudant - v0.12.1

Schema for database properties.

+

Constructors

Properties

Methods

Constructors

Properties

partitioned?: boolean

The value is true for a partitioned database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DbEvent-1.html b/docs/0.12.1/classes/CloudantV1.DbEvent-1.html new file mode 100644 index 000000000..5c005ccf9 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DbEvent-1.html @@ -0,0 +1,11 @@ +DbEvent | @ibm-cloud/cloudant - v0.12.1

Schema for a database change event.

+

Constructors

Properties

Methods

Constructors

Properties

dbName: string

Schema for a database name.

+
seq: string

Sequence number.

+
type: string

A database event.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DbUpdates-1.html b/docs/0.12.1/classes/CloudantV1.DbUpdates-1.html new file mode 100644 index 000000000..a9cbc0b6b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DbUpdates-1.html @@ -0,0 +1,9 @@ +DbUpdates | @ibm-cloud/cloudant - v0.12.1

Schema for database updates.

+

Constructors

Properties

Methods

Constructors

Properties

lastSeq: string

Last sequence number.

+
results: CloudantV1.DbEvent[]

results.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DbsInfoResult-1.html b/docs/0.12.1/classes/CloudantV1.DbsInfoResult-1.html new file mode 100644 index 000000000..556ede995 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DbsInfoResult-1.html @@ -0,0 +1,11 @@ +DbsInfoResult | @ibm-cloud/cloudant - v0.12.1

Schema for database information keyed by database name.

+

Constructors

Properties

Methods

Constructors

Properties

error?: string

The name of the error.

+

Schema for information about a database.

+
key: string

Schema for a database name.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DesignDocument-1.html b/docs/0.12.1/classes/CloudantV1.DesignDocument-1.html new file mode 100644 index 000000000..3eb6a7fd7 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DesignDocument-1.html @@ -0,0 +1,102 @@ +DesignDocument | @ibm-cloud/cloudant - v0.12.1

Schema for a design document.

+

This type supports additional properties of type any.

+

Indexable

  • [propName: string]: any

    DesignDocument accepts additional properties of type any.

    +

Constructors

Properties

_attachments?: { [key: string]: CloudantV1.Attachment }

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Schema for a design document ID including a _design/ prefix.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: CloudantV1.Revisions

Schema for list of revision information.

+

Schema for a list of objects with information about local revisions and their status.

+
autoupdate?: boolean

Indicates whether to automatically build indexes defined in this design document.

+
filters?: JsonObject

Schema for filter functions definition. This schema is a map where keys are the names of the filter +functions and values are the function definition in string format.

+

Filter function formats, or filters the changes feed that pass filter rules. The function takes 2 parameters:

+
    +
  • +

    doc: The document that is being processed.

    +
  • +
  • +

    req: A Request JavaScript object with these properties:

    +
      +
    • body - string, Request body data as string. +If the request method is GET this field contains the value +"undefined". +If the method is DELETE or HEAD the value is "" (empty string).
    • +
    • cookie - Cookies object.
    • +
    • form - Form Data object, contains the decoded body as key-value +pairs if the Content-Type header was +application/x-www-form-urlencoded.
    • +
    • headers - Request Headers object.
    • +
    • id - string, requested document id if it was specified +or null otherwise.
    • +
    • info - Database Information object, +see DatabaseInformation.
    • +
    • method - string or an array of chars, request method. +String value is a method as one of: HEAD, GET, POST, PUT, +DELETE, OPTIONS, TRACE, COPY. For not supported methods +it will be represented as an array of char codes e.g. for VIEW +it will be 86,73,69,87.
    • +
    • path - array of strings, requested path sections.
    • +
    • peer - string, request source IP address.
    • +
    • query - string, URL query parameters object. Note that multiple +keys are not supported and the last key value suppresses others.
    • +
    • requested_path - array of strings, +actual requested path section.
    • +
    • raw_path - string, raw requested path.
    • +
    • userCtx: User Context Object, containing information about the +user writing the document (if present), see the UserContext.
    • +
    • secObj: Security Object, with lists of database security roles, +see the SecurityObject.
    • +
    • uuid - string, generated UUID by a specified algorithm in the +config file.
    • +
    +
  • +
+

Filter functions must return true if a document passed all the rules.

+
indexes?: { [key: string]: CloudantV1.SearchIndexDefinition }

Search (text) index function definitions.

+
language?: string

Defines Query Server key to process design document functions.

+

Schema for design document options.

+
validateDocUpdate?: string

Validate document update function can be used to prevent invalid or unauthorized document update requests +from being stored. Validation functions typically examine the structure of the new document to ensure that +required fields are present and to verify that the requesting user should be allowed to make changes to the +document properties. When a write request is received for a given database, the validation function in each +design document in that database is called in an unspecified order. If any of the validation functions throw an +error, the write will not succeed.

+

The validation function can abort the pending document write by throwing one of two error objects:

+
// user is not authorized to make the change but may re-authenticate throw({ unauthorized: 'Error message here.'
});

// change is not allowed throw({ forbidden: 'Error message here.' }); +
+ +

The function takes 4 parameters:

+
    +
  • newDoc - New version of document that will be stored +from the update request.
  • +
  • oldDoc - Previous version of document that is already stored.
  • +
  • userCtx - User Context Object, containing information about the +user writing the document (if present), see the UserContext.
  • +
  • secObj - Security Object, with lists of database security roles, +see the SecurityObject.
  • +
+
views?: { [key: string]: CloudantV1.DesignDocumentViewsMapReduce }

Schema for design document views.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DesignDocumentInformation-1.html b/docs/0.12.1/classes/CloudantV1.DesignDocumentInformation-1.html new file mode 100644 index 000000000..1a2e0818b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DesignDocumentInformation-1.html @@ -0,0 +1,9 @@ +DesignDocumentInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about a design document.

+

Constructors

Properties

Methods

Constructors

Properties

name: string

name.

+

View index information.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DesignDocumentOptions-1.html b/docs/0.12.1/classes/CloudantV1.DesignDocumentOptions-1.html new file mode 100644 index 000000000..625f1433b --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DesignDocumentOptions-1.html @@ -0,0 +1,7 @@ +DesignDocumentOptions | @ibm-cloud/cloudant - v0.12.1

Schema for design document options.

+

Constructors

Properties

Methods

Constructors

Properties

partitioned?: boolean

Whether this design document describes partitioned or global indexes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DesignDocumentViewIndex-1.html b/docs/0.12.1/classes/CloudantV1.DesignDocumentViewIndex-1.html new file mode 100644 index 000000000..e6919cc0f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DesignDocumentViewIndex-1.html @@ -0,0 +1,24 @@ +DesignDocumentViewIndex | @ibm-cloud/cloudant - v0.12.1

View index information.

+

Constructors

Properties

collatorVersions: string[]

List of collator versions. If there are multiple entries this implies a libicu upgrade has occurred but +compaction has not run yet.

+
compactRunning: boolean

Indicates whether a compaction routine is currently running on the view.

+
language: string

Language for the defined views.

+
signature: string

MD5 signature of the views for the design document.

+

Schema for size information of content.

+
updaterRunning: boolean

Indicates if the view is currently being updated.

+
updatesPending: CloudantV1.UpdatesPending

Schema for an ability to tell if view is up-to-date without querying it.

+
waitingClients: number

Number of clients waiting on views from this design document.

+
waitingCommit: boolean

Indicates if there are outstanding commits to the underlying database that need to processed.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DesignDocumentViewsMapReduce-1.html b/docs/0.12.1/classes/CloudantV1.DesignDocumentViewsMapReduce-1.html new file mode 100644 index 000000000..40e68cdc8 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DesignDocumentViewsMapReduce-1.html @@ -0,0 +1,9 @@ +DesignDocumentViewsMapReduce | @ibm-cloud/cloudant - v0.12.1

Schema for view functions definition.

+

Constructors

Properties

Methods

Constructors

Properties

map: string

JavaScript map function as a string.

+
reduce?: string

JavaScript reduce function as a string.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DocsResultRow-1.html b/docs/0.12.1/classes/CloudantV1.DocsResultRow-1.html new file mode 100644 index 000000000..bdce1c29a --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DocsResultRow-1.html @@ -0,0 +1,21 @@ +DocsResultRow | @ibm-cloud/cloudant - v0.12.1

Schema for a row of document information in a DocsResult.

+

Constructors

Properties

Methods

Constructors

Properties

causedBy?: string

The cause of the error (if available).

+

Schema for a document.

+
error?: string

The name of the error.

+
id?: string

Schema for a document ID.

+
key: string

Schema for a document ID.

+
reason?: string

The reason the error occurred (if available).

+
ref?: number

An internal error reference (if available).

+

Value of built-in /_all_docs style view.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DocsResultRowValue-1.html b/docs/0.12.1/classes/CloudantV1.DocsResultRowValue-1.html new file mode 100644 index 000000000..b5e5a7e78 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DocsResultRowValue-1.html @@ -0,0 +1,9 @@ +DocsResultRowValue | @ibm-cloud/cloudant - v0.12.1

Value of built-in /_all_docs style view.

+

Constructors

Properties

Methods

Constructors

Properties

deleted?: boolean

If true then the document is deleted. Not present for undeleted documents.

+
rev: string

Schema for a document revision identifier.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Document-1.html b/docs/0.12.1/classes/CloudantV1.Document-1.html new file mode 100644 index 000000000..cdd6da059 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Document-1.html @@ -0,0 +1,25 @@ +Document | @ibm-cloud/cloudant - v0.12.1

Schema for a document.

+

This type supports additional properties of type any.

+

Indexable

  • [propName: string]: any

    Document accepts additional properties of type any.

    +

Constructors

Properties

_attachments?: { [key: string]: CloudantV1.Attachment }

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Schema for a document ID.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: CloudantV1.Revisions

Schema for list of revision information.

+

Schema for a list of objects with information about local revisions and their status.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DocumentResult-1.html b/docs/0.12.1/classes/CloudantV1.DocumentResult-1.html new file mode 100644 index 000000000..b73d5fa96 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DocumentResult-1.html @@ -0,0 +1,19 @@ +DocumentResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of a document modification.

+

Constructors

Properties

Methods

Constructors

Properties

causedBy?: string

The cause of the error (if available).

+
error?: string

The name of the error.

+
id: string

Schema for a document ID.

+
ok?: boolean

ok.

+
reason?: string

The reason the error occurred (if available).

+
ref?: number

An internal error reference (if available).

+
rev?: string

Schema for a document revision identifier.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DocumentRevisionStatus-1.html b/docs/0.12.1/classes/CloudantV1.DocumentRevisionStatus-1.html new file mode 100644 index 000000000..64d48b498 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DocumentRevisionStatus-1.html @@ -0,0 +1,10 @@ +DocumentRevisionStatus | @ibm-cloud/cloudant - v0.12.1

Schema for information about revisions and their status.

+

Constructors

Properties

Methods

Constructors

Properties

rev: string

Schema for a document revision identifier.

+
status: string

Status of the revision. May be one of: - available: Revision is available for retrieving with rev query +parameter - missing: Revision is not available - deleted: Revision belongs to deleted document.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.DocumentShardInfo-1.html b/docs/0.12.1/classes/CloudantV1.DocumentShardInfo-1.html new file mode 100644 index 000000000..6dbe97c00 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.DocumentShardInfo-1.html @@ -0,0 +1,9 @@ +DocumentShardInfo | @ibm-cloud/cloudant - v0.12.1

Schema for document shard information.

+

Constructors

Properties

Methods

Constructors

Properties

nodes: string[]

List of nodes serving a replica of the shard.

+
range: string

The shard range in which the document is stored.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ExecutionStats-1.html b/docs/0.12.1/classes/CloudantV1.ExecutionStats-1.html new file mode 100644 index 000000000..3d049e0ee --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ExecutionStats-1.html @@ -0,0 +1,15 @@ +ExecutionStats | @ibm-cloud/cloudant - v0.12.1

Schema for find query execution statistics.

+

Constructors

Properties

executionTimeMs: number

Time to execute the query.

+
resultsReturned: number

Number of results returned.

+
totalDocsExamined: number

Number of documents fetched from the index.

+
totalKeysExamined: number

Number of rows scanned in the index.

+
totalQuorumDocsExamined: number

Number of documents fetched from the primary index with the specified read quorum.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ExplainResult-1.html b/docs/0.12.1/classes/CloudantV1.ExplainResult-1.html new file mode 100644 index 000000000..a465d2f1e --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ExplainResult-1.html @@ -0,0 +1,60 @@ +ExplainResult | @ibm-cloud/cloudant - v0.12.1

Schema for information about the index used for a find query.

+

Constructors

Properties

covering: boolean

When true, the query is answered using the index only and no documents are fetched.

+
dbname: string

Schema for a database name.

+
fields: string[]

Fields that were requested to be projected from the document. If no fields were requested to be projected +this will be empty and all fields will be returned.

+

Schema for information about an index.

+
indexCandidates: CloudantV1.IndexCandidate[]

Schema for the list of all the other indexes that were not chosen for serving the query.

+
limit: number

The used maximum number of results returned.

+

Arguments passed to the underlying view.

+

Options used for the request.

+
partitioned?: any

Schema for any JSON type.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
selectorHints: CloudantV1.SelectorHint[]

Schema for a list of objects with extra information on the selector to provide insights about its usability.

+
skip: number

Skip parameter used.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ExplainResultMrArgs-1.html b/docs/0.12.1/classes/CloudantV1.ExplainResultMrArgs-1.html new file mode 100644 index 000000000..18fe7dae9 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ExplainResultMrArgs-1.html @@ -0,0 +1,28 @@ +ExplainResultMrArgs | @ibm-cloud/cloudant - v0.12.1

Arguments passed to the underlying view.

+

Constructors

Properties

conflicts: any

Schema for any JSON type.

+
direction: string

Direction parameter passed to the underlying view.

+
endKey: any

Schema for any JSON type.

+
includeDocs: boolean

A parameter that specifies whether to include the full content of the documents in the response in the +underlying view.

+
partition: string

Partition parameter passed to the underlying view.

+
reduce: boolean

A parameter that specifies returning only documents that match any of the specified keys in the underlying +view.

+
stable: boolean

A parameter that specifies whether the view results should be returned form a "stable" set of shards passed +to the underlying view.

+
startKey?: any

Schema for any JSON type.

+
update: any

Schema for any JSON type.

+
viewType: string

The type of the underlying view.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ExplainResultOpts-1.html b/docs/0.12.1/classes/CloudantV1.ExplainResultOpts-1.html new file mode 100644 index 000000000..f7fe1a316 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ExplainResultOpts-1.html @@ -0,0 +1,33 @@ +ExplainResultOpts | @ibm-cloud/cloudant - v0.12.1

Options used for the request.

+

Constructors

Properties

bookmark: string

Opaque bookmark token used when paginating results.

+
conflicts: boolean

Conflicts used in the request query.

+
executionStats: boolean

Execution statistics used in the request query.

+
fields: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
limit: number

Limit used in the request query.

+
partition: string

On which database partition the request was used. If it was not used on a database partition, it returns +with "".

+
r: number

The read quorum that is needed for the result.

+
skip: number

Skip used in the request query.

+
sort: any

Schema for any JSON type.

+
stable: boolean

Stable used in the request query.

+
stale: boolean

Deprecated: Stale used in the request query.

+
update: boolean

Update used in the request query.

+
useIndex: string[]

Use index used in the request query.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.FindResult-1.html b/docs/0.12.1/classes/CloudantV1.FindResult-1.html new file mode 100644 index 000000000..bcbf297e7 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.FindResult-1.html @@ -0,0 +1,13 @@ +FindResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of a query find operation.

+

Constructors

Properties

bookmark: string

Opaque bookmark token used when paginating results.

+

Documents matching the selector.

+
executionStats?: CloudantV1.ExecutionStats

Schema for find query execution statistics.

+
warning?: string

warning.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexAnalysis-1.html b/docs/0.12.1/classes/CloudantV1.IndexAnalysis-1.html new file mode 100644 index 000000000..99a6c6c86 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexAnalysis-1.html @@ -0,0 +1,13 @@ +IndexAnalysis | @ibm-cloud/cloudant - v0.12.1

Schema for detailed explanation of why the specific index was excluded by the query planner.

+

Constructors

Properties

Methods

Constructors

Properties

covering: boolean

When true, the query is answered using the index only and no documents are fetched.

+
ranking: number

A position of the unused index based on its potential relevance to the query.

+

A list of reasons explaining why index was not chosen for the query.

+
usable: boolean

Indicates whether an index can still be used for the query.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexAnalysisExclusionReason-1.html b/docs/0.12.1/classes/CloudantV1.IndexAnalysisExclusionReason-1.html new file mode 100644 index 000000000..3cefffbca --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexAnalysisExclusionReason-1.html @@ -0,0 +1,24 @@ +IndexAnalysisExclusionReason | @ibm-cloud/cloudant - v0.12.1

A reason for index's exclusion.

+

Constructors

Properties

Methods

Constructors

Properties

name: string

A reason code for index's exclusion.

+

The full list of possible reason codes is following:

+
    +
  • alphabetically_comes_after: json +There is another suitable index whose name comes before that of this index.
  • +
  • empty_selector: text +"text" indexes do not support queries with empty selectors.
  • +
  • excluded_by_user: any use_index was used to manually specify the index.
  • +
  • field_mismatch: any Fields in "selector" of the query do match with the fields available in the index.
  • +
  • is_partial: json, text Partial indexes can be selected only manually.
  • +
  • less_overlap: json There is a better match of fields available within the indexes for the query.
  • +
  • needs_text_search: json The use of the $text operator requires a "text" index.
  • +
  • scope_mismatch: json The scope of the query and the index is not the same.
  • +
  • sort_order_mismatch: json, special Fields in "sort" of the query do not match with the fields available in the +index.
  • +
  • too_many_fields: json The index has more fields than the chosen one.
  • +
  • unfavored_type: any The type of the index is not preferred.
  • +
+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexCandidate-1.html b/docs/0.12.1/classes/CloudantV1.IndexCandidate-1.html new file mode 100644 index 000000000..47a32c584 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexCandidate-1.html @@ -0,0 +1,9 @@ +IndexCandidate | @ibm-cloud/cloudant - v0.12.1

Schema for an index that was not chosen for serving the query with the reason for the exclusion.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for detailed explanation of why the specific index was excluded by the query planner.

+

Schema for information about an index.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexDefinition-1.html b/docs/0.12.1/classes/CloudantV1.IndexDefinition-1.html new file mode 100644 index 000000000..5d54df171 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexDefinition-1.html @@ -0,0 +1,60 @@ +IndexDefinition | @ibm-cloud/cloudant - v0.12.1

Schema for a json or text query index definition. Indexes of type text have additional configuration +properties that do not apply to json indexes, these are:

+
    +
  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all +document fields and what analyzer to use for that purpose.
  • +
+

Constructors

Properties

defaultAnalyzer?: CloudantV1.Analyzer

Schema for a full text search analyzer.

+

Schema for the text index default field configuration. The default field is used to index the text of all +fields within a document for use with the $text operator.

+

List of field objects to index. Nested fields are also allowed, e.g. person.name.

+

For "json" type indexes each object is a mapping of field name to sort direction (asc or desc).

+

For "text" type indexes each object has a name property of the field name and a type property of the field +type (string, number, or boolean).

+
indexArrayLengths?: boolean

Whether to scan every document for arrays and store the length for each array found. Set the +index_array_lengths field to false if:

+
    +
  • You do not need to know the length of an array. * You do not use the $size operator. * The documents in your +database are complex, or not completely under your control. As a result, it is difficult to estimate the impact +of the extra processing that is needed to determine and store the arrays lengths.
  • +
+
partialFilterSelector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexField-1.html b/docs/0.12.1/classes/CloudantV1.IndexField-1.html new file mode 100644 index 000000000..0928ff9e1 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexField-1.html @@ -0,0 +1,11 @@ +IndexField | @ibm-cloud/cloudant - v0.12.1

Schema for indexed fields for use with declarative JSON query.

+

This type supports additional properties of type string. Schema for sort direction.

+

Indexable

  • [propName: string]: any

    IndexField accepts additional properties of type string. Schema for sort direction.

    +

Constructors

Properties

Methods

Constructors

Properties

name?: string

Name of the field.

+
type?: string

The type of the named field.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexInformation-1.html b/docs/0.12.1/classes/CloudantV1.IndexInformation-1.html new file mode 100644 index 000000000..b56711944 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexInformation-1.html @@ -0,0 +1,20 @@ +IndexInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about an index.

+

Constructors

Properties

Methods

Constructors

Properties

ddoc: string

Schema for a nullable design document ID including a _design/ prefix.

+

Schema for a json or text query index definition. Indexes of type text have additional configuration +properties that do not apply to json indexes, these are:

+
    +
  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all +document fields and what analyzer to use for that purpose.
  • +
+
name: string

Index name.

+
partitioned?: boolean

Indicates if index is partitioned.

+
type: string

Schema for the type of an index.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexResult-1.html b/docs/0.12.1/classes/CloudantV1.IndexResult-1.html new file mode 100644 index 000000000..26e3b2767 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexResult-1.html @@ -0,0 +1,11 @@ +IndexResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of creating an index.

+

Constructors

Properties

Methods

Constructors

Properties

id: string

Id of the design document the index was created in.

+
name: string

Name of the index created.

+
result: string

Flag to show whether the index was created or one already exists.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexTextOperatorDefaultField-1.html b/docs/0.12.1/classes/CloudantV1.IndexTextOperatorDefaultField-1.html new file mode 100644 index 000000000..e26845ee2 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexTextOperatorDefaultField-1.html @@ -0,0 +1,10 @@ +IndexTextOperatorDefaultField | @ibm-cloud/cloudant - v0.12.1

Schema for the text index default field configuration. The default field is used to index the text of all fields +within a document for use with the $text operator.

+

Constructors

Properties

Methods

Constructors

Properties

analyzer?: CloudantV1.Analyzer

Schema for a full text search analyzer.

+
enabled?: boolean

Whether or not the default_field is enabled.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.IndexesInformation-1.html b/docs/0.12.1/classes/CloudantV1.IndexesInformation-1.html new file mode 100644 index 000000000..3c0a0ccc0 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.IndexesInformation-1.html @@ -0,0 +1,9 @@ +IndexesInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about the indexes in a database.

+

Constructors

Properties

Methods

Constructors

Properties

Indexes.

+
totalRows: number

Total number of query indexes in the database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.JsonObject.html b/docs/0.12.1/classes/CloudantV1.JsonObject.html new file mode 100644 index 000000000..46dd773f2 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.JsonObject.html @@ -0,0 +1,5 @@ +JsonObject | @ibm-cloud/cloudant - v0.12.1

A standard JS object, defined to avoid the limitations of Object and object

+

Indexable

  • [key: string]: any

Constructors

Methods

Constructors

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.MembershipInformation-1.html b/docs/0.12.1/classes/CloudantV1.MembershipInformation-1.html new file mode 100644 index 000000000..2d96d3004 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.MembershipInformation-1.html @@ -0,0 +1,9 @@ +MembershipInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about known nodes and cluster membership.

+

Constructors

Properties

Methods

Constructors

Properties

allNodes: string[]

List of nodes this node knows about, including the ones that are part of the cluster.

+
clusterNodes: string[]

All cluster nodes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Ok-1.html b/docs/0.12.1/classes/CloudantV1.Ok-1.html new file mode 100644 index 000000000..9b758e3ba --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Ok-1.html @@ -0,0 +1,7 @@ +Ok | @ibm-cloud/cloudant - v0.12.1

Schema for an OK result.

+

Constructors

Properties

ok? +

Methods

Constructors

Properties

ok?: boolean

ok.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionInformation-1.html b/docs/0.12.1/classes/CloudantV1.PartitionInformation-1.html new file mode 100644 index 000000000..747588a27 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionInformation-1.html @@ -0,0 +1,17 @@ +PartitionInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about a database partition.

+

Constructors

Properties

dbName: string

Schema for a database name.

+
docCount: number

A count of the documents in the specified database partition.

+
docDelCount: number

Number of deleted documents.

+
partition: string

Schema for a partition key.

+

Schema for information about the partition index count and limit in a database.

+

The size of active and external data, in bytes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexes-1.html b/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexes-1.html new file mode 100644 index 000000000..a3ad55252 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexes-1.html @@ -0,0 +1,11 @@ +PartitionInformationIndexes | @ibm-cloud/cloudant - v0.12.1

Schema for information about the partition index count and limit in a database.

+

Constructors

Properties

Methods

Constructors

Properties

count?: number

Total count of the partitioned indexes.

+

The count breakdown of partitioned indexes.

+
limit?: number

The partitioned index limit.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexesIndexes-1.html b/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexesIndexes-1.html new file mode 100644 index 000000000..f695906d7 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionInformationIndexesIndexes-1.html @@ -0,0 +1,9 @@ +PartitionInformationIndexesIndexes | @ibm-cloud/cloudant - v0.12.1

The count breakdown of partitioned indexes.

+

Constructors

Properties

Methods

Constructors

Properties

search?: number

Number of partitioned search indexes.

+
view?: number

Number of partitioned view indexes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionInformationSizes-1.html b/docs/0.12.1/classes/CloudantV1.PartitionInformationSizes-1.html new file mode 100644 index 000000000..fff1be175 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionInformationSizes-1.html @@ -0,0 +1,9 @@ +PartitionInformationSizes | @ibm-cloud/cloudant - v0.12.1

The size of active and external data, in bytes.

+

Constructors

Properties

Methods

Constructors

Properties

active?: number

The size of live data inside the database, in bytes.

+
external?: number

The uncompressed size of database contents in bytes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionedIndexesDetailedInformation-1.html b/docs/0.12.1/classes/CloudantV1.PartitionedIndexesDetailedInformation-1.html new file mode 100644 index 000000000..e44f61fc1 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionedIndexesDetailedInformation-1.html @@ -0,0 +1,9 @@ +PartitionedIndexesDetailedInformation | @ibm-cloud/cloudant - v0.12.1

Number of partitioned indexes by type.

+

Constructors

Properties

Methods

Constructors

Properties

search?: number

Number of partitioned indexes of search type.

+
view?: number

Number of partitioned indexes of view type.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.PartitionedIndexesInformation-1.html b/docs/0.12.1/classes/CloudantV1.PartitionedIndexesInformation-1.html new file mode 100644 index 000000000..7f099c3bd --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.PartitionedIndexesInformation-1.html @@ -0,0 +1,11 @@ +PartitionedIndexesInformation | @ibm-cloud/cloudant - v0.12.1

Information about database's partitioned indexes.

+

Constructors

Properties

Methods

Constructors

Properties

count?: number

Total number of partitioned indexes in the database.

+

Number of partitioned indexes by type.

+
limit?: number

Maximum allowed number of partitioned indexes in the database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationCreateTargetParameters-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationCreateTargetParameters-1.html new file mode 100644 index 000000000..db2650f53 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationCreateTargetParameters-1.html @@ -0,0 +1,12 @@ +ReplicationCreateTargetParameters | @ibm-cloud/cloudant - v0.12.1

Request parameters to use during target database creation.

+

Constructors

Properties

Methods

Constructors

Properties

n?: number

Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it +cannot be changed by the user.

+
partitioned?: boolean

Parameter to specify whether to enable database partitions when creating the target database.

+
q?: number

Schema for the number of shards in a database. Each shard is a partition of the hash value range.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationDatabase-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationDatabase-1.html new file mode 100644 index 000000000..afcb94897 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationDatabase-1.html @@ -0,0 +1,11 @@ +ReplicationDatabase | @ibm-cloud/cloudant - v0.12.1

Schema for a replication source or target database.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for replication source or target database authentication.

+
headers?: JsonObject

Replication request headers.

+
url: string

Replication database URL.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuth-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuth-1.html new file mode 100644 index 000000000..b29cd9ca0 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuth-1.html @@ -0,0 +1,9 @@ +ReplicationDatabaseAuth | @ibm-cloud/cloudant - v0.12.1

Schema for replication source or target database authentication.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for basic authentication of replication source or target database.

+

Schema for an IAM API key for replication database authentication.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthBasic-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthBasic-1.html new file mode 100644 index 000000000..aef36c7f5 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthBasic-1.html @@ -0,0 +1,9 @@ +ReplicationDatabaseAuthBasic | @ibm-cloud/cloudant - v0.12.1

Schema for basic authentication of replication source or target database.

+

Constructors

Properties

Methods

Constructors

Properties

password: string

The password associated with the username.

+
username: string

Schema for a username.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthIam-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthIam-1.html new file mode 100644 index 000000000..a98082c6f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationDatabaseAuthIam-1.html @@ -0,0 +1,7 @@ +ReplicationDatabaseAuthIam | @ibm-cloud/cloudant - v0.12.1

Schema for an IAM API key for replication database authentication.

+

Constructors

Properties

Methods

Constructors

Properties

apiKey: string

IAM API key.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ReplicationDocument-1.html b/docs/0.12.1/classes/CloudantV1.ReplicationDocument-1.html new file mode 100644 index 000000000..12c307bcf --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ReplicationDocument-1.html @@ -0,0 +1,122 @@ +ReplicationDocument | @ibm-cloud/cloudant - v0.12.1

Schema for a replication document. Note that selector, doc_ids, and filter are incompatible with each other.

+

This type supports additional properties of type any.

+

Indexable

  • [propName: string]: any

    ReplicationDocument accepts additional properties of type any.

    +

Constructors

Properties

_attachments?: { [key: string]: CloudantV1.Attachment }

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Schema for a document ID.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: CloudantV1.Revisions

Schema for list of revision information.

+

Schema for a list of objects with information about local revisions and their status.

+
cancel?: boolean

Cancels the replication.

+
checkpointInterval?: number

Defines replication checkpoint interval in milliseconds.

+
connectionTimeout?: number

HTTP connection timeout per replication. Even for very fast/reliable networks it might need to be increased +if a remote database is too busy.

+
continuous?: boolean

Configure the replication to be continuous.

+
createTarget?: boolean

Creates the target database. Requires administrator privileges on target server.

+

Request parameters to use during target database creation.

+
docIds?: string[]

Schema for a list of document IDs.

+
filter?: string

The name of a filter function which is defined in a design document in the source database in +{ddoc_id}/{filter} format. It determines which documents get replicated. Using the selector option provides +performance benefits when compared with using the filter option. Use the selector option when possible.

+
httpConnections?: number

Maximum number of HTTP connections per replication.

+
owner?: string

The replication document owner. The server sets an appropriate value if the field is unset when writing a +replication document. Only administrators can modify the value to an owner other than themselves.

+
queryParams?: JsonObject

Schema for a map of string key value pairs, such as query parameters.

+
retriesPerRequest?: number

Number of times a replication request is retried. The requests are retried with a doubling exponential +backoff starting at 0.25 seconds, with a cap at 5 minutes.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
sinceSeq?: string

Start the replication at a specific sequence value.

+
socketOptions?: string

Replication socket options.

+

Schema for a replication source or target database.

+
sourceProxy?: string

Deprecated: This setting is forbidden in IBM Cloudant replication documents. This setting may be used with +alternative replication mediators.

+

Address of a (http or socks5 protocol) proxy server through which replication with the source database should +occur.

+

Schema for a replication source or target database.

+
targetProxy?: string

Deprecated: This setting is forbidden in IBM Cloudant replication documents. This setting may be used with +alternative replication mediators.

+

Address of a (http or socks5 protocol) proxy server through which replication with the target database should +occur.

+
useBulkGet?: boolean

Specify whether to use _bulk_get for fetching documents from the source. If unset, the server configured +default will be used.

+
useCheckpoints?: boolean

Specify if checkpoints should be saved during replication. Using checkpoints means a replication can be +efficiently resumed.

+

Schema for the user context of a session.

+
winningRevsOnly?: boolean

Replicate only the winning revisions. Replication with this mode discards conflicting revisions. Replication +IDs and checkpoints generated by this mode are different to those generated by default, so it is possible to +first replicate the winning revisions then later backfill remaining revisions with a regular replication job.

+
workerBatchSize?: number

Controls how many documents are processed. After each batch a checkpoint is written so this controls how +frequently checkpointing occurs.

+
workerProcesses?: number

Controls how many separate processes will read from the changes manager and write to the target. A higher +number can improve throughput.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Revisions-1.html b/docs/0.12.1/classes/CloudantV1.Revisions-1.html new file mode 100644 index 000000000..2c587c2f8 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Revisions-1.html @@ -0,0 +1,9 @@ +Revisions | @ibm-cloud/cloudant - v0.12.1

Schema for list of revision information.

+

Constructors

Properties

Methods

Constructors

Properties

ids: string[]

Array of valid revision IDs, in reverse order (latest first).

+
start: number

Prefix number for the latest revision.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.RevsDiff-1.html b/docs/0.12.1/classes/CloudantV1.RevsDiff-1.html new file mode 100644 index 000000000..f0da718d9 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.RevsDiff-1.html @@ -0,0 +1,9 @@ +RevsDiff | @ibm-cloud/cloudant - v0.12.1

Schema for information about missing revs and possible ancestors.

+

Constructors

Properties

Methods

Constructors

Properties

missing?: string[]

List of missing revisions.

+
possibleAncestors?: string[]

List of possible ancestor revisions.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerDocsResult-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerDocsResult-1.html new file mode 100644 index 000000000..46026713f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerDocsResult-1.html @@ -0,0 +1,9 @@ +SchedulerDocsResult | @ibm-cloud/cloudant - v0.12.1

Schema for a listing of replication scheduler documents.

+

Constructors

Properties

Methods

Constructors

Properties

Array of replication scheduler doc objects.

+
totalRows: number

Total number of replication scheduler documents.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerDocument-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerDocument-1.html new file mode 100644 index 000000000..582c2e82f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerDocument-1.html @@ -0,0 +1,36 @@ +SchedulerDocument | @ibm-cloud/cloudant - v0.12.1

Schema for a replication scheduler document.

+

Constructors

Properties

database: string

Database where replication document came from.

+
docId: string

Replication document ID.

+
errorCount: number

Consecutive errors count. Indicates how many times in a row this replication has crashed. Replication will +be retried with an exponential backoff based on this number. As soon as the replication succeeds this count is +reset to 0. To can be used to get an idea why a particular replication is not making progress.

+
id: string

Replication ID, or null if state is completed or failed.

+

Schema for scheduler document information. A JSON object that may contain additional information about the +state. For error states this will contain an error field and string value.

+
lastUpdated: string

Timestamp of last state update.

+
node?: string

Cluster node where the job is running.

+
source?: string

Replication source.

+
sourceProxy?: string

Deprecated: Forbidden in IBM Cloudant mediated replications.

+

Address of the (http or socks5 protocol) proxy server through which replication with the source database occurs.

+
startTime: string

Timestamp of when the replication was started.

+
state: string

Schema for replication state.

+
target?: string

Replication target.

+
targetProxy?: string

Deprecated: Forbidden in IBM Cloudant mediated replications.

+

Address of the (http or socks5 protocol) proxy server through which replication with the target database occurs.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerInfo-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerInfo-1.html new file mode 100644 index 000000000..dffa25116 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerInfo-1.html @@ -0,0 +1,26 @@ +SchedulerInfo | @ibm-cloud/cloudant - v0.12.1

Schema for scheduler document information. A JSON object that may contain additional information about the state. +For error states this will contain an error field and string value.

+

Constructors

Properties

changesPending?: number

The count of changes not yet replicated.

+
checkpointedSourceSeq?: string

The source sequence id which was last successfully replicated.

+
docsRead?: number

The count of docs which have been read from the source.

+
docsWritten?: number

The count of docs which have been written to the target.

+
docWriteFailures?: number

The count of docs which failed to be written to the target.

+
error?: string

Replication error message.

+
missingRevisionsFound?: number

The count of revisions which were found on the source, but missing from the target.

+
revisionsChecked?: number

The count of revisions which have been checked since this replication began.

+
sourceSeq?: string

The last sequence number obtained from the source database changes feed.

+
throughSeq?: string

The last sequence number processed by the replicator.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerJob-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerJob-1.html new file mode 100644 index 000000000..fb13dfc71 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerJob-1.html @@ -0,0 +1,28 @@ +SchedulerJob | @ibm-cloud/cloudant - v0.12.1

Schema for a replication scheduler job.

+

Constructors

Properties

database: string

Replication document database.

+
docId: string

Replication document ID.

+

Timestamped history of events as a list of objects.

+
id: string

Schema for a replication job id.

+

Schema for scheduler document information. A JSON object that may contain additional information about the +state. For error states this will contain an error field and string value.

+
node: string

Cluster node where the job is running.

+
pid: string

Replication process ID.

+
source: string

Replication source.

+
startTime: string

Timestamp of when the replication was started.

+
target: string

Replication target.

+
user: string

Name of user running the process.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerJobEvent-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerJobEvent-1.html new file mode 100644 index 000000000..f60ca29f3 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerJobEvent-1.html @@ -0,0 +1,11 @@ +SchedulerJobEvent | @ibm-cloud/cloudant - v0.12.1

Schema for a replication scheduler job event.

+

Constructors

Properties

Methods

Constructors

Properties

reason?: string

Reason for current state of event.

+
timestamp: string

Timestamp of the event.

+
type: string

Type of the event.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SchedulerJobsResult-1.html b/docs/0.12.1/classes/CloudantV1.SchedulerJobsResult-1.html new file mode 100644 index 000000000..029d6ad80 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SchedulerJobsResult-1.html @@ -0,0 +1,9 @@ +SchedulerJobsResult | @ibm-cloud/cloudant - v0.12.1

Schema for a listing of replication scheduler jobs.

+

Constructors

Properties

Methods

Constructors

Properties

Array of replication job objects.

+
totalRows: number

Total number of replication jobs.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchAnalyzeResult-1.html b/docs/0.12.1/classes/CloudantV1.SearchAnalyzeResult-1.html new file mode 100644 index 000000000..1b67d46b3 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchAnalyzeResult-1.html @@ -0,0 +1,7 @@ +SearchAnalyzeResult | @ibm-cloud/cloudant - v0.12.1

Schema for the output of testing search analyzer tokenization.

+

Constructors

Properties

Methods

Constructors

Properties

tokens: string[]

tokens.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchDiskSizeInformation-1.html b/docs/0.12.1/classes/CloudantV1.SearchDiskSizeInformation-1.html new file mode 100644 index 000000000..dd871476d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchDiskSizeInformation-1.html @@ -0,0 +1,9 @@ +SearchDiskSizeInformation | @ibm-cloud/cloudant - v0.12.1

Schema for search index disk size.

+

Constructors

Properties

Methods

Constructors

Properties

name: string

The name of the search index prefixed by the design document ID where the index is stored.

+

Schema for search index disk size.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchIndexDefinition-1.html b/docs/0.12.1/classes/CloudantV1.SearchIndexDefinition-1.html new file mode 100644 index 000000000..1aac72bfd --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchIndexDefinition-1.html @@ -0,0 +1,35 @@ +SearchIndexDefinition | @ibm-cloud/cloudant - v0.12.1

Schema for a search index definition.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for a search analyzer configuration.

+
index: string

String form of a JavaScript function that is called for each document in the database. The function takes +the document as a parameter, extracts some data from it, and then calls the index function to index that data. +The index function takes 2, or optionally 3, parameters.

+
    +
  • +

    The first parameter is the name of the field you intend to use when +querying the index. If the special value "default" is used when you +define the name, you do not have to specify a field name at query time.

    +
  • +
  • +

    The second parameter is the data to be indexed. This data must be only a +string, number, or boolean. Other types will cause an error to be thrown +by the index function call.

    +
  • +
  • +

    The optional third parameter is a JavaScript object with these +properties:

    +
      +
    • facet - boolean, default false - Creates a faceted index.
    • +
    • index - boolean, default true - If set to false, the data +cannot be used for searches, but can still be retrieved from the +index if store is set to true.
    • +
    • store - boolean, default true - If true, the value is returned +in the search result; otherwise, the value is not returned.
    • +
    +
  • +
+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchIndexDiskSize-1.html b/docs/0.12.1/classes/CloudantV1.SearchIndexDiskSize-1.html new file mode 100644 index 000000000..af010b332 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchIndexDiskSize-1.html @@ -0,0 +1,7 @@ +SearchIndexDiskSize | @ibm-cloud/cloudant - v0.12.1

Schema for search index disk size.

+

Constructors

Properties

Methods

Constructors

Properties

diskSize?: number

The size of the search index on disk.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchIndexInfo-1.html b/docs/0.12.1/classes/CloudantV1.SearchIndexInfo-1.html new file mode 100644 index 000000000..aa6371909 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchIndexInfo-1.html @@ -0,0 +1,17 @@ +SearchIndexInfo | @ibm-cloud/cloudant - v0.12.1

Schema for metadata information about a search index.

+

Constructors

Properties

committedSeq: number

The committed sequence identifier.

+
diskSize: number

The size of the search index on disk.

+
docCount: number

The count of the number of indexed documents.

+
docDelCount: number

The number of deleted documents.

+
pendingSeq: number

The pending sequence identifier.

+
signature: string

Unique signature of the search index.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchInfoResult-1.html b/docs/0.12.1/classes/CloudantV1.SearchInfoResult-1.html new file mode 100644 index 000000000..275295ac1 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchInfoResult-1.html @@ -0,0 +1,9 @@ +SearchInfoResult | @ibm-cloud/cloudant - v0.12.1

Schema for search index information.

+

Constructors

Properties

Methods

Constructors

Properties

name: string

The name of the search index prefixed by the design document ID where the index is stored.

+

Schema for metadata information about a search index.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchResult-1.html b/docs/0.12.1/classes/CloudantV1.SearchResult-1.html new file mode 100644 index 000000000..5288283ad --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchResult-1.html @@ -0,0 +1,21 @@ +SearchResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of a query search operation.

+

Constructors

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
by?: string

Grouped search matches.

+
counts?: { [key: string]: JsonObject }

The counts facet syntax returns the number of query results for each unique value of each named field.

+

Array of grouped search matches.

+
ranges?: { [key: string]: JsonObject }

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit +into each specified category.

+

Array of row objects.

+
totalRows: number

Total number of rows in the index matching the search query. The limit may truncate the number of matches +returned.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchResultProperties-1.html b/docs/0.12.1/classes/CloudantV1.SearchResultProperties-1.html new file mode 100644 index 000000000..60a3907b9 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchResultProperties-1.html @@ -0,0 +1,19 @@ +SearchResultProperties | @ibm-cloud/cloudant - v0.12.1

Schema for the result of a query search operation.

+

Constructors

Properties

Methods

Constructors

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
by?: string

Grouped search matches.

+
counts?: { [key: string]: JsonObject }

The counts facet syntax returns the number of query results for each unique value of each named field.

+
ranges?: { [key: string]: JsonObject }

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit +into each specified category.

+

Array of row objects.

+
totalRows: number

Total number of rows in the index matching the search query. The limit may truncate the number of matches +returned.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SearchResultRow-1.html b/docs/0.12.1/classes/CloudantV1.SearchResultRow-1.html new file mode 100644 index 000000000..70c39b7cd --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SearchResultRow-1.html @@ -0,0 +1,14 @@ +SearchResultRow | @ibm-cloud/cloudant - v0.12.1

Schema for a row of the result of a query search operation.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for a document.

+
fields: JsonObject

Schema for the fields returned by a query search operation, a map of field name to value.

+
highlights?: JsonObject

Returns the context in which a search term was mentioned so that you can display more emphasized results to +a user.

+
id: string

Schema for a document ID.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.Security-1.html b/docs/0.12.1/classes/CloudantV1.Security-1.html new file mode 100644 index 000000000..ad28a5ee5 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.Security-1.html @@ -0,0 +1,13 @@ +Security | @ibm-cloud/cloudant - v0.12.1

Schema for a security document.

+

Constructors

Properties

Schema for names and roles to map to a database permission.

+
cloudant?: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdbAuthOnly?: boolean

Manage permissions using the _users database only.

+

Schema for names and roles to map to a database permission.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SecurityObject-1.html b/docs/0.12.1/classes/CloudantV1.SecurityObject-1.html new file mode 100644 index 000000000..934045a6c --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SecurityObject-1.html @@ -0,0 +1,9 @@ +SecurityObject | @ibm-cloud/cloudant - v0.12.1

Schema for names and roles to map to a database permission.

+

Constructors

Properties

Methods

Constructors

Properties

names?: string[]

List of usernames.

+
roles?: string[]

List of roles.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SelectorHint-1.html b/docs/0.12.1/classes/CloudantV1.SelectorHint-1.html new file mode 100644 index 000000000..5bb671288 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SelectorHint-1.html @@ -0,0 +1,11 @@ +SelectorHint | @ibm-cloud/cloudant - v0.12.1

Schema for extra information on the selector.

+

Constructors

Properties

indexableFields: string[]

A list of fields in the given selector that can be used to restrict the query.

+
type: string

A type of the index.

+
unindexableFields: string[]

A list of fields in the given selector that can't be used to restrict the query.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ServerInformation-1.html b/docs/0.12.1/classes/CloudantV1.ServerInformation-1.html new file mode 100644 index 000000000..377ed9b35 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ServerInformation-1.html @@ -0,0 +1,15 @@ +ServerInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about the server instance.

+

Constructors

Properties

couchdb: string

Welcome message.

+
features: string[]

List of enabled optional features.

+
featuresFlags: string[]

List of feature flags.

+

Schema for server vendor information.

+
version: string

Apache CouchDB version.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ServerVendor-1.html b/docs/0.12.1/classes/CloudantV1.ServerVendor-1.html new file mode 100644 index 000000000..d953abfdd --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ServerVendor-1.html @@ -0,0 +1,13 @@ +ServerVendor | @ibm-cloud/cloudant - v0.12.1

Schema for server vendor information.

+

This type supports additional properties of type string.

+

Indexable

  • [propName: string]: any

    ServerVendor accepts additional properties of type string.

    +

Constructors

Properties

Methods

Constructors

Properties

name: string

Vendor name.

+
variant: string

Vendor variant.

+
version: string

Vendor version.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SessionAuthentication-1.html b/docs/0.12.1/classes/CloudantV1.SessionAuthentication-1.html new file mode 100644 index 000000000..35cd62720 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SessionAuthentication-1.html @@ -0,0 +1,11 @@ +SessionAuthentication | @ibm-cloud/cloudant - v0.12.1

Schema for session authentication information.

+

Constructors

Properties

authenticated?: string

authenticated.

+
authenticationDb?: string

authentication_db.

+
authenticationHandlers: string[]

authentication_handlers.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.SessionInformation-1.html b/docs/0.12.1/classes/CloudantV1.SessionInformation-1.html new file mode 100644 index 000000000..3851f259e --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.SessionInformation-1.html @@ -0,0 +1,11 @@ +SessionInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about a session.

+

Constructors

Properties

Methods

Constructors

Properties

Schema for session authentication information.

+
ok: boolean

ok.

+

Schema for the user context of a session.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ShardsInformation-1.html b/docs/0.12.1/classes/CloudantV1.ShardsInformation-1.html new file mode 100644 index 000000000..a925e342d --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ShardsInformation-1.html @@ -0,0 +1,8 @@ +ShardsInformation | @ibm-cloud/cloudant - v0.12.1

Schema for a shards object that maps the hash value range for each shard to the array of nodes that contain a copy +of that shard.

+

Constructors

Properties

Methods

Constructors

Properties

shards: JsonObject

Mapping of shard hash value range to a list of nodes.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ThroughputInformation-1.html b/docs/0.12.1/classes/CloudantV1.ThroughputInformation-1.html new file mode 100644 index 000000000..68da76611 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ThroughputInformation-1.html @@ -0,0 +1,14 @@ +ThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.

+

Constructors

Properties

Methods

Constructors

Properties

blocks?: number

A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global +queries/sec of provisioned throughput capacity. Not available for some plans.

+
query: number

Provisioned global queries capacity in operations per second.

+
read: number

Provisioned reads capacity in operations per second.

+
write: number

Provisioned writes capacity in operations per second.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.UpInformation-1.html b/docs/0.12.1/classes/CloudantV1.UpInformation-1.html new file mode 100644 index 000000000..ab43e4289 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.UpInformation-1.html @@ -0,0 +1,9 @@ +UpInformation | @ibm-cloud/cloudant - v0.12.1

Schema for information about the up state of the server.

+

Constructors

Properties

Methods

Constructors

Properties

seeds?: JsonObject

seeds.

+
status: string

status.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.UpdatesPending-1.html b/docs/0.12.1/classes/CloudantV1.UpdatesPending-1.html new file mode 100644 index 000000000..c9300ad72 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.UpdatesPending-1.html @@ -0,0 +1,12 @@ +UpdatesPending | @ibm-cloud/cloudant - v0.12.1

Schema for an ability to tell if view is up-to-date without querying it.

+

Constructors

Properties

Methods

Constructors

Properties

minimum: number

Sum of shard copies with the least amount of work to do.

+
preferred: number

Sum of unique shards. This value is zero when at least one copy of every shard range is up-to-date and the +view is able to answer a query without index building delays.

+
total: number

Sum of all shard copies.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.UserContext-1.html b/docs/0.12.1/classes/CloudantV1.UserContext-1.html new file mode 100644 index 000000000..4f7a19537 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.UserContext-1.html @@ -0,0 +1,11 @@ +UserContext | @ibm-cloud/cloudant - v0.12.1

Schema for the user context of a session.

+

Constructors

Properties

Methods

Constructors

Properties

db?: string

Database name in the context of the provided operation.

+
name: string

Name of user running the process.

+
roles: string[] | Roles[]

List of user roles.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.UuidsResult-1.html b/docs/0.12.1/classes/CloudantV1.UuidsResult-1.html new file mode 100644 index 000000000..88fdf8054 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.UuidsResult-1.html @@ -0,0 +1,7 @@ +UuidsResult | @ibm-cloud/cloudant - v0.12.1

Schema for a set of uuids generated by the server.

+

Constructors

Properties

Methods

Constructors

Properties

uuids: string[]

uuids.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ViewQueriesResult-1.html b/docs/0.12.1/classes/CloudantV1.ViewQueriesResult-1.html new file mode 100644 index 000000000..17f333736 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ViewQueriesResult-1.html @@ -0,0 +1,8 @@ +ViewQueriesResult | @ibm-cloud/cloudant - v0.12.1

Schema for the results of a queries view operation.

+

Constructors

Properties

Methods

Constructors

Properties

An array of result objects - one for each query. Each result object contains the same fields as the response +to a regular view request.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ViewQuery-1.html b/docs/0.12.1/classes/CloudantV1.ViewQuery-1.html new file mode 100644 index 000000000..64245655f --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ViewQuery-1.html @@ -0,0 +1,65 @@ +ViewQuery | @ibm-cloud/cloudant - v0.12.1

Schema for a query view operation.

+

Constructors

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

+

A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

+

Be aware that include_docs=true can only be used with map views.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value +false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true +when used in conjunction with update=false may improve consistency at the expense of increased latency and +decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ViewResult-1.html b/docs/0.12.1/classes/CloudantV1.ViewResult-1.html new file mode 100644 index 000000000..290c7a93a --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ViewResult-1.html @@ -0,0 +1,13 @@ +ViewResult | @ibm-cloud/cloudant - v0.12.1

Schema for the result of a query view operation.

+

Constructors

Properties

Methods

Constructors

Properties

rows.

+
totalRows?: number

Total number of rows in the view index. Note that if the request query narrows the view this is not the +number of matching rows. The number of matching rows, up to the specified limit, is the size of the rows +array.

+
updateSeq?: string

Current update sequence for the database.

+

Methods

diff --git a/docs/0.12.1/classes/CloudantV1.ViewResultRow-1.html b/docs/0.12.1/classes/CloudantV1.ViewResultRow-1.html new file mode 100644 index 000000000..f1f980e56 --- /dev/null +++ b/docs/0.12.1/classes/CloudantV1.ViewResultRow-1.html @@ -0,0 +1,21 @@ +ViewResultRow | @ibm-cloud/cloudant - v0.12.1

Schema for a row of a view result.

+

Constructors

Properties

Methods

Constructors

Properties

causedBy?: string

The cause of the error (if available).

+

Schema for a document.

+
error?: string

The name of the error.

+
id?: string

Schema for a document ID.

+
key: any

Schema for any JSON type.

+
reason?: string

The reason the error occurred (if available).

+
ref?: number

An internal error reference (if available).

+
value: any

Schema for any JSON type.

+

Methods

diff --git a/docs/0.12.1/classes/CouchdbSessionAuthenticator.html b/docs/0.12.1/classes/CouchdbSessionAuthenticator.html new file mode 100644 index 000000000..eaff2cd94 --- /dev/null +++ b/docs/0.12.1/classes/CouchdbSessionAuthenticator.html @@ -0,0 +1,30 @@ +CouchdbSessionAuthenticator | @ibm-cloud/cloudant - v0.12.1

Class CouchdbSessionAuthenticator

The CouchdbSessionAuthenticator is used to get CouchDB session authentication information to +requests.

+

CouchDB Session Authenticator stores Authentication data in a Cookie Jar and +that will be used during a request. +The following token information are stored in the CookieJar.

+
Cookie-Content: AuthSession=<sessionToken>; Expires=<expirationDate>; Max-Age=<refreshmentTimeInSeconds>
+                Version=1; Path=/; HttpOnly; Secure
+
+

Hierarchy

  • Authenticator
    • CouchdbSessionAuthenticator

Constructors

Properties

requiredOptions: ["username", "password"]
tokenManager: SessionTokenManager
AUTHTYPE_COUCHDB_SESSION: "COUCHDB_SESSION" = 'COUCHDB_SESSION'

Methods

  • Acquire a session token that will be stored in a Cookie Jar. +The same jar will be in use in the request.

    +

    Parameters

    • requestOptions: object

      The request to augment with authentication +information.

      +

    Returns Promise<void>

  • Returns the authenticator's type ('COUCHDB_SESSION').

    +

    Returns string

    a string that indicates the authenticator's type

    +
  • Configure the TokenManager to use all the request settings +together with the basic credentials.

    +

    Parameters

    • userOptions: UserOptions

      Configuration values for a request service.

      +

    Returns void

diff --git a/docs/0.12.1/classes/Stream.html b/docs/0.12.1/classes/Stream.html new file mode 100644 index 000000000..bfb6592a0 --- /dev/null +++ b/docs/0.12.1/classes/Stream.html @@ -0,0 +1,41 @@ +Stream | @ibm-cloud/cloudant - v0.12.1

Type Parameters

  • T

Hierarchy

  • Transform
    • Stream

Constructors

Methods

Constructors

Methods

  • Parameters

    • chunk: T
    • Optionalencoding: BufferEncoding

    Returns boolean

  • The readable.read() method reads data out of the internal buffer and +returns it. If no data is available to be read, null is returned. By default, +the data is returned as a Buffer object unless an encoding has been +specified using the readable.setEncoding() method or the stream is operating +in object mode.

    +

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned.

    +

    If the size argument is not specified, all of the data contained in the +internal buffer will be returned.

    +

    The size argument must be less than or equal to 1 GiB.

    +

    The readable.read() method should only be called on Readable streams +operating in paused mode. In flowing mode, readable.read() is called +automatically until the internal buffer is fully drained.

    +
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
    let chunk;
    console.log('Stream is readable (new data received in buffer)');
    // Use a loop to make sure we read all currently available data
    while (null !== (chunk = readable.read())) {
    console.log(`Read ${chunk.length} bytes of data...`);
    }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
    console.log('Reached end of stream.');
    }); +
    + +

    Each call to readable.read() returns a chunk of data, or null. The chunks +are not concatenated. A while loop is necessary to consume all data +currently in the buffer. When reading a large file .read() may return null, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new 'readable' event will be emitted +when there is more data in the buffer. Finally the 'end' event will be +emitted when there is no more data to come.

    +

    Therefore to read a file's whole contents from a readable, it is necessary +to collect chunks across multiple 'readable' events:

    +
    const chunks = [];

    readable.on('readable', () => {
    let chunk;
    while (null !== (chunk = readable.read())) {
    chunks.push(chunk);
    }
    });

    readable.on('end', () => {
    const content = chunks.join('');
    }); +
    + +

    A Readable stream in object mode will always return a single item from +a call to readable.read(size), regardless of the value of thesize argument.

    +

    If the readable.read() method returns a chunk of data, a 'data' event will +also be emitted.

    +

    Calling read after the 'end' event has +been emitted will return null. No runtime error will be raised.

    +

    Parameters

    • Optionalsize: number

      Optional argument to specify how much data to read.

      +

    Returns T

    v0.9.4

    +
diff --git a/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Phase.html b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Phase.html new file mode 100644 index 000000000..8b40f43c0 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Phase.html @@ -0,0 +1,7 @@ +Phase | @ibm-cloud/cloudant - v0.12.1

The phase the active task is in. docid_sort, docid_copy, document_copy phases are available for database_compaction, while ids and view phases are available for view_compaction type tasks.

+

Enumeration Members

Enumeration Members

DOCID_COPY: "docid_copy"
DOCID_SORT: "docid_sort"
DOCUMENT_COPY: "document_copy"
IDS: "ids"
VIEW: "view"
diff --git a/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.ProcessStatus.html b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.ProcessStatus.html new file mode 100644 index 000000000..bed3e5066 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.ProcessStatus.html @@ -0,0 +1,8 @@ +ProcessStatus | @ibm-cloud/cloudant - v0.12.1

Process status.

+

Enumeration Members

EXITING: "exiting"
GARBAGE_COLLECTING: "garbage_collecting"
RUNNABLE: "runnable"
RUNNING: "running"
SUSPENDED: "suspended"
WAITING: "waiting"
diff --git a/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Type.html b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Type.html new file mode 100644 index 000000000..29397e889 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ActiveTask.Constants.Type.html @@ -0,0 +1,7 @@ +Type | @ibm-cloud/cloudant - v0.12.1

Operation type.

+

Enumeration Members

DATABASE_COMPACTION: "database_compaction"
INDEXER: "indexer"
REPLICATION: "replication"
SEARCH_INDEXER: "search_indexer"
VIEW_COMPACTION: "view_compaction"
diff --git a/docs/0.12.1/enums/CloudantV1.ActivityTrackerEvents.Constants.Types.html b/docs/0.12.1/enums/CloudantV1.ActivityTrackerEvents.Constants.Types.html new file mode 100644 index 000000000..077c9daa0 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ActivityTrackerEvents.Constants.Types.html @@ -0,0 +1,4 @@ +Types | @ibm-cloud/cloudant - v0.12.1

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. "management" is a required element of this array.

+

Enumeration Members

Enumeration Members

DATA: "data"
MANAGEMENT: "management"
diff --git a/docs/0.12.1/enums/CloudantV1.Analyzer.Constants.Name.html b/docs/0.12.1/enums/CloudantV1.Analyzer.Constants.Name.html new file mode 100644 index 000000000..f98e9f7fa --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.Analyzer.Constants.Name.html @@ -0,0 +1,43 @@ +Name | @ibm-cloud/cloudant - v0.12.1

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is standard * For query text indexes the default is keyword * For a query text index default_field the default is standard.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERFIELD: "perfield"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"
diff --git a/docs/0.12.1/enums/CloudantV1.AnalyzerConfiguration.Constants.Name.html b/docs/0.12.1/enums/CloudantV1.AnalyzerConfiguration.Constants.Name.html new file mode 100644 index 000000000..66028ae39 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.AnalyzerConfiguration.Constants.Name.html @@ -0,0 +1,43 @@ +Name | @ibm-cloud/cloudant - v0.12.1

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is standard * For query text indexes the default is keyword * For a query text index default_field the default is standard.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERFIELD: "perfield"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"
diff --git a/docs/0.12.1/enums/CloudantV1.DbEvent.Constants.Type.html b/docs/0.12.1/enums/CloudantV1.DbEvent.Constants.Type.html new file mode 100644 index 000000000..65523e715 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DbEvent.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.12.1

A database event.

+

Enumeration Members

Enumeration Members

CREATED: "created"
DELETED: "deleted"
UPDATED: "updated"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteAttachmentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.DeleteAttachmentConstants.Batch.html new file mode 100644 index 000000000..19420e515 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteAttachmentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteDesignDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.DeleteDesignDocumentConstants.Batch.html new file mode 100644 index 000000000..91be1f5e4 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteDesignDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.DeleteDocumentConstants.Batch.html new file mode 100644 index 000000000..174d52e75 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteIndexConstants.Type.html b/docs/0.12.1/enums/CloudantV1.DeleteIndexConstants.Type.html new file mode 100644 index 000000000..89c759471 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteIndexConstants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.12.1

Path parameter to specify the index type.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteLocalDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.DeleteLocalDocumentConstants.Batch.html new file mode 100644 index 000000000..40e205e35 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteLocalDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.DeleteReplicationDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.DeleteReplicationDocumentConstants.Batch.html new file mode 100644 index 000000000..c0226bbd8 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DeleteReplicationDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.DocumentRevisionStatus.Constants.Status.html b/docs/0.12.1/enums/CloudantV1.DocumentRevisionStatus.Constants.Status.html new file mode 100644 index 000000000..5757ef1a7 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.DocumentRevisionStatus.Constants.Status.html @@ -0,0 +1,5 @@ +Status | @ibm-cloud/cloudant - v0.12.1

Status of the revision. May be one of: - available: Revision is available for retrieving with rev query parameter - missing: Revision is not available - deleted: Revision belongs to deleted document.

+

Enumeration Members

Enumeration Members

AVAILABLE: "available"
DELETED: "deleted"
MISSING: "missing"
diff --git a/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.Direction.html b/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.Direction.html new file mode 100644 index 000000000..e37601790 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.Direction.html @@ -0,0 +1,4 @@ +Direction | @ibm-cloud/cloudant - v0.12.1

Direction parameter passed to the underlying view.

+

Enumeration Members

FWD +REV +

Enumeration Members

FWD: "fwd"
REV: "rev"
diff --git a/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.ViewType.html b/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.ViewType.html new file mode 100644 index 000000000..45c17d6ee --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ExplainResultMrArgs.Constants.ViewType.html @@ -0,0 +1,4 @@ +ViewType | @ibm-cloud/cloudant - v0.12.1

The type of the underlying view.

+

Enumeration Members

Enumeration Members

MAP: "map"
REDUCE: "reduce"
diff --git a/docs/0.12.1/enums/CloudantV1.GetDbUpdatesConstants.Feed.html b/docs/0.12.1/enums/CloudantV1.GetDbUpdatesConstants.Feed.html new file mode 100644 index 000000000..5b7747ba8 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.GetDbUpdatesConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"
diff --git a/docs/0.12.1/enums/CloudantV1.GetLocalDocumentConstants.Accept.html b/docs/0.12.1/enums/CloudantV1.GetLocalDocumentConstants.Accept.html new file mode 100644 index 000000000..e83d6fb9a --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.GetLocalDocumentConstants.Accept.html @@ -0,0 +1,6 @@ +Accept | @ibm-cloud/cloudant - v0.12.1

The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"
diff --git a/docs/0.12.1/enums/CloudantV1.GetSchedulerDocsConstants.States.html b/docs/0.12.1/enums/CloudantV1.GetSchedulerDocsConstants.States.html new file mode 100644 index 000000000..d323b8040 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.GetSchedulerDocsConstants.States.html @@ -0,0 +1,9 @@ +States | @ibm-cloud/cloudant - v0.12.1

Query parameter to include only replication documents in the specified states. String must be a comma-delimited string.

+

Enumeration Members

COMPLETED: "completed"
CRASHING: "crashing"
ERROR: "error"
FAILED: "failed"
INITIALIZING: "initializing"
PENDING: "pending"
RUNNING: "running"
diff --git a/docs/0.12.1/enums/CloudantV1.IndexAnalysisExclusionReason.Constants.Name.html b/docs/0.12.1/enums/CloudantV1.IndexAnalysisExclusionReason.Constants.Name.html new file mode 100644 index 000000000..c18878b56 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.IndexAnalysisExclusionReason.Constants.Name.html @@ -0,0 +1,13 @@ +Name | @ibm-cloud/cloudant - v0.12.1

A reason code for index's exclusion. The full list of possible reason codes is following: * alphabetically_comes_after: json There is another suitable index whose name comes before that of this index. * empty_selector: text "text" indexes do not support queries with empty selectors. * excluded_by_user: any use_index was used to manually specify the index. * field_mismatch: any Fields in "selector" of the query do match with the fields available in the index. * is_partial: json, text Partial indexes can be selected only manually. * less_overlap: json There is a better match of fields available within the indexes for the query. * needs_text_search: json The use of the $text operator requires a "text" index. * scope_mismatch: json The scope of the query and the index is not the same. * sort_order_mismatch: json, special Fields in "sort" of the query do not match with the fields available in the index. * too_many_fields: json The index has more fields than the chosen one. * unfavored_type: any The type of the index is not preferred.

+

Enumeration Members

ALPHABETICALLY_COMES_AFTER: "alphabetically_comes_after"
EMPTY_SELECTOR: "empty_selector"
EXCLUDED_BY_USER: "excluded_by_user"
FIELD_MISMATCH: "field_mismatch"
IS_PARTIAL: "is_partial"
LESS_OVERLAP: "less_overlap"
NEEDS_TEXT_SEARCH: "needs_text_search"
SCOPE_MISMATCH: "scope_mismatch"
SORT_ORDER_MISMATCH: "sort_order_mismatch"
TOO_MANY_FIELDS: "too_many_fields"
UNFAVORED_TYPE: "unfavored_type"
diff --git a/docs/0.12.1/enums/CloudantV1.IndexField.Constants.Type.html b/docs/0.12.1/enums/CloudantV1.IndexField.Constants.Type.html new file mode 100644 index 000000000..4db8e42ac --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.IndexField.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.12.1

The type of the named field.

+

Enumeration Members

Enumeration Members

BOOLEAN: "boolean"
NUMBER: "number"
STRING: "string"
diff --git a/docs/0.12.1/enums/CloudantV1.IndexInformation.Constants.Type.html b/docs/0.12.1/enums/CloudantV1.IndexInformation.Constants.Type.html new file mode 100644 index 000000000..b449714bd --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.IndexInformation.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.12.1

Schema for the type of an index.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"
diff --git a/docs/0.12.1/enums/CloudantV1.IndexResult.Constants.Result.html b/docs/0.12.1/enums/CloudantV1.IndexResult.Constants.Result.html new file mode 100644 index 000000000..31a339568 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.IndexResult.Constants.Result.html @@ -0,0 +1,4 @@ +Result | @ibm-cloud/cloudant - v0.12.1

Flag to show whether the index was created or one already exists.

+

Enumeration Members

Enumeration Members

CREATED: "created"
EXISTS: "exists"
diff --git a/docs/0.12.1/enums/CloudantV1.PostActivityTrackerEventsConstants.Types.html b/docs/0.12.1/enums/CloudantV1.PostActivityTrackerEventsConstants.Types.html new file mode 100644 index 000000000..9c8ed88e0 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostActivityTrackerEventsConstants.Types.html @@ -0,0 +1,4 @@ +Types | @ibm-cloud/cloudant - v0.12.1

Types

+

Enumeration Members

Enumeration Members

DATA: "data"
MANAGEMENT: "management"
diff --git a/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Feed.html b/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Feed.html new file mode 100644 index 000000000..df42b768c --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"
diff --git a/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Style.html b/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Style.html new file mode 100644 index 000000000..3851b69bf --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostChangesAsStreamConstants.Style.html @@ -0,0 +1,4 @@ +Style | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts).

+

Enumeration Members

Enumeration Members

ALL_DOCS: "all_docs"
MAIN_ONLY: "main_only"
diff --git a/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Feed.html b/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Feed.html new file mode 100644 index 000000000..526fc810e --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"
diff --git a/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Style.html b/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Style.html new file mode 100644 index 000000000..7f4a223f8 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostChangesConstants.Style.html @@ -0,0 +1,4 @@ +Style | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts).

+

Enumeration Members

Enumeration Members

ALL_DOCS: "all_docs"
MAIN_ONLY: "main_only"
diff --git a/docs/0.12.1/enums/CloudantV1.PostDesignDocsQueriesConstants.Accept.html b/docs/0.12.1/enums/CloudantV1.PostDesignDocsQueriesConstants.Accept.html new file mode 100644 index 000000000..68b38ba70 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostDesignDocsQueriesConstants.Accept.html @@ -0,0 +1,4 @@ +Accept | @ibm-cloud/cloudant - v0.12.1

The type of the response: application/json or application/octet-stream.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
diff --git a/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.Batch.html new file mode 100644 index 000000000..cc36e02d9 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.ContentType.html b/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.ContentType.html new file mode 100644 index 000000000..c842b3404 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.12.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"
diff --git a/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Sort.html new file mode 100644 index 000000000..450e84454 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Update.html new file mode 100644 index 000000000..c752dea69 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostExplainConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Sort.html new file mode 100644 index 000000000..fb4524ffd --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Update.html new file mode 100644 index 000000000..2ee9e74b3 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostFindAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostFindConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostFindConstants.Sort.html new file mode 100644 index 000000000..f2bbc13c0 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostFindConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostFindConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostFindConstants.Update.html new file mode 100644 index 000000000..e8bdf095e --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostFindConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostIndexConstants.Type.html b/docs/0.12.1/enums/CloudantV1.PostIndexConstants.Type.html new file mode 100644 index 000000000..2eef1c68c --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostIndexConstants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.12.1

Schema for the type of an index.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Sort.html new file mode 100644 index 000000000..b83afa50b --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Update.html new file mode 100644 index 000000000..33a4c6aab --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionExplainConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Sort.html new file mode 100644 index 000000000..1962e23bb --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Update.html new file mode 100644 index 000000000..7371e1521 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionFindAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Sort.html b/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Sort.html new file mode 100644 index 000000000..fe825b708 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.12.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Update.html new file mode 100644 index 000000000..871897be8 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionFindConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionSearchAsStreamConstants.Stale.html b/docs/0.12.1/enums/CloudantV1.PostPartitionSearchAsStreamConstants.Stale.html new file mode 100644 index 000000000..6f9229608 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionSearchAsStreamConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.12.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionSearchConstants.Stale.html b/docs/0.12.1/enums/CloudantV1.PostPartitionSearchConstants.Stale.html new file mode 100644 index 000000000..7a1505c9c --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionSearchConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.12.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionViewAsStreamConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostPartitionViewAsStreamConstants.Update.html new file mode 100644 index 000000000..68788f520 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionViewAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostPartitionViewConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostPartitionViewConstants.Update.html new file mode 100644 index 000000000..cfa3fe9fe --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostPartitionViewConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostReplicatorConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PostReplicatorConstants.Batch.html new file mode 100644 index 000000000..0d660c2b2 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostReplicatorConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostSearchAnalyzeConstants.Analyzer.html b/docs/0.12.1/enums/CloudantV1.PostSearchAnalyzeConstants.Analyzer.html new file mode 100644 index 000000000..c58b28e51 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostSearchAnalyzeConstants.Analyzer.html @@ -0,0 +1,42 @@ +Analyzer | @ibm-cloud/cloudant - v0.12.1

The analyzer type that is being used at the tokenization.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"
diff --git a/docs/0.12.1/enums/CloudantV1.PostSearchAsStreamConstants.Stale.html b/docs/0.12.1/enums/CloudantV1.PostSearchAsStreamConstants.Stale.html new file mode 100644 index 000000000..0bce5334b --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostSearchAsStreamConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.12.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostSearchConstants.Stale.html b/docs/0.12.1/enums/CloudantV1.PostSearchConstants.Stale.html new file mode 100644 index 000000000..f29468fc4 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostSearchConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.12.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PostViewAsStreamConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostViewAsStreamConstants.Update.html new file mode 100644 index 000000000..45782f169 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostViewAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PostViewConstants.Update.html b/docs/0.12.1/enums/CloudantV1.PostViewConstants.Update.html new file mode 100644 index 000000000..a8939e25e --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PostViewConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/enums/CloudantV1.PutCloudantSecurityConfigurationConstants.Cloudant.html b/docs/0.12.1/enums/CloudantV1.PutCloudantSecurityConfigurationConstants.Cloudant.html new file mode 100644 index 000000000..d58c7a9fc --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutCloudantSecurityConfigurationConstants.Cloudant.html @@ -0,0 +1,10 @@ +Cloudant | @ibm-cloud/cloudant - v0.12.1

Database permissions for Cloudant users and/or API keys.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"
diff --git a/docs/0.12.1/enums/CloudantV1.PutDesignDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PutDesignDocumentConstants.Batch.html new file mode 100644 index 000000000..a1e406b73 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutDesignDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.Batch.html new file mode 100644 index 000000000..17ae2b084 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.ContentType.html b/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.ContentType.html new file mode 100644 index 000000000..2147c79a2 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.12.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"
diff --git a/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.Batch.html new file mode 100644 index 000000000..af857ecde --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.ContentType.html b/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.ContentType.html new file mode 100644 index 000000000..9ae264b0a --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutLocalDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.12.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"
diff --git a/docs/0.12.1/enums/CloudantV1.PutReplicationDocumentConstants.Batch.html b/docs/0.12.1/enums/CloudantV1.PutReplicationDocumentConstants.Batch.html new file mode 100644 index 000000000..912f2320b --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutReplicationDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.12.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.PutSecurityConstants.Cloudant.html b/docs/0.12.1/enums/CloudantV1.PutSecurityConstants.Cloudant.html new file mode 100644 index 000000000..038507e18 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.PutSecurityConstants.Cloudant.html @@ -0,0 +1,10 @@ +Cloudant | @ibm-cloud/cloudant - v0.12.1

Database permissions for Cloudant users and/or API keys.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"
diff --git a/docs/0.12.1/enums/CloudantV1.SchedulerDocument.Constants.State.html b/docs/0.12.1/enums/CloudantV1.SchedulerDocument.Constants.State.html new file mode 100644 index 000000000..3ddc4586f --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.SchedulerDocument.Constants.State.html @@ -0,0 +1,9 @@ +State | @ibm-cloud/cloudant - v0.12.1

Schema for replication state.

+

Enumeration Members

COMPLETED: "completed"
CRASHING: "crashing"
ERROR: "error"
FAILED: "failed"
INITIALIZING: "initializing"
PENDING: "pending"
RUNNING: "running"
diff --git a/docs/0.12.1/enums/CloudantV1.SelectorHint.Constants.Type.html b/docs/0.12.1/enums/CloudantV1.SelectorHint.Constants.Type.html new file mode 100644 index 000000000..973d30238 --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.SelectorHint.Constants.Type.html @@ -0,0 +1,4 @@ +Type | @ibm-cloud/cloudant - v0.12.1

A type of the index.

+

Enumeration Members

Enumeration Members

JSON: "json"
TEXT: "text"
diff --git a/docs/0.12.1/enums/CloudantV1.ServerVendor.Constants.Variant.html b/docs/0.12.1/enums/CloudantV1.ServerVendor.Constants.Variant.html new file mode 100644 index 000000000..4df6142ec --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ServerVendor.Constants.Variant.html @@ -0,0 +1,3 @@ +Variant | @ibm-cloud/cloudant - v0.12.1

Vendor variant.

+

Enumeration Members

Enumeration Members

PAAS: "paas"
diff --git a/docs/0.12.1/enums/CloudantV1.UpInformation.Constants.Status.html b/docs/0.12.1/enums/CloudantV1.UpInformation.Constants.Status.html new file mode 100644 index 000000000..6d41917ae --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.UpInformation.Constants.Status.html @@ -0,0 +1,5 @@ +Status | @ibm-cloud/cloudant - v0.12.1

status.

+

Enumeration Members

Enumeration Members

MAINTENANCE_MODE: "maintenance_mode"
NOLB: "nolb"
OK: "ok"
diff --git a/docs/0.12.1/enums/CloudantV1.UserContext.Constants.Roles.html b/docs/0.12.1/enums/CloudantV1.UserContext.Constants.Roles.html new file mode 100644 index 000000000..41386ca0a --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.UserContext.Constants.Roles.html @@ -0,0 +1,10 @@ +Roles | @ibm-cloud/cloudant - v0.12.1

List of user roles.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"
diff --git a/docs/0.12.1/enums/CloudantV1.ViewQuery.Constants.Update.html b/docs/0.12.1/enums/CloudantV1.ViewQuery.Constants.Update.html new file mode 100644 index 000000000..8dd055ddd --- /dev/null +++ b/docs/0.12.1/enums/CloudantV1.ViewQuery.Constants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.12.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"
diff --git a/docs/0.12.1/index.html b/docs/0.12.1/index.html new file mode 100644 index 000000000..d946dac42 --- /dev/null +++ b/docs/0.12.1/index.html @@ -0,0 +1,750 @@ +@ibm-cloud/cloudant - v0.12.1

@ibm-cloud/cloudant - v0.12.1

Build Status +Release +Docs

+

IBM Cloudant Node.js SDK Version 0.12.1

IBM Cloudant Node.js SDK is a client library that interacts with the +IBM Cloudant APIs.

+

Disclaimer: This library is still a 0.x release. We do consider this +library production-ready and capable, but there are still some +limitations we’re working to resolve, and refinements we want to +deliver. We are working really hard to minimise the disruption from +now until the 1.0 release, but there may still be some changes that +impact applications using this SDK. For now, be sure to pin versions +to avoid surprises.

+
+Table of Contents + + +
+

The IBM Cloudant Node.js SDK allows developers to programmatically +interact with IBM Cloudant +with the help of the @ibm-cloud/cloudant package.

+

The purpose of this Node.js SDK is to wrap most of the HTTP request APIs +provided by Cloudant and supply other functions to ease the usage of Cloudant. +This SDK should make life easier for programmers to do what’s really important +to them: developing software.

+

Reasons why you should consider using Cloudant Node.js SDK in your +project:

+
    +
  • Supported by IBM Cloudant.
  • +
  • Server compatibility with: + +
  • +
  • Includes all the most popular and latest supported endpoints for +applications.
  • +
  • Handles the authentication.
  • +
  • Familiar user experience with IBM Cloud SDKs.
  • +
  • Flexibility to use either built-in models or byte-based requests and responses for documents.
  • +
  • Built-in Changes feed follower (beta)
  • +
  • Promise based design with asynchronous HTTP requests.
  • +
  • Use either as native JavaScript or take advantage of TypeScript models.
  • +
  • Transparently compresses request and response bodies.
  • +
+
    +
  • A +Cloudant +service instance or a +CouchDB +server.
  • +
  • Node.js 18, 20, or 22.
  • +
+
npm install @ibm-cloud/cloudant
+
+ +

For fundamental SDK usage information and config options, please see the common IBM Cloud SDK documentation.

+

This library requires configuration with a service URL and +Cloudant service credentials to authenticate with your +account.

+

There are several ways to set these authentication properties:

+
    +
  1. As environment variables
  2. +
  3. The programmatic approach
  4. +
  5. With an external credentials file
  6. +
+

The following section describes the different authentication types and provides environment variable examples. +Examples for other configuration methods are available by following the provided links.

+

This library requires credentials to authenticate with IBM Cloudant. These credentials may be:

+
    +
  • IBM Cloud IAM credentials (can be used with authentication types CONTAINER, VPC and IAM) + +
  • +
  • Username and password credentials (can be used with authentication types COUCHDB_SESSION and BASIC) + +
  • +
+

For other compatible APIs that are not Cloudant accounts (e.g. Apache CouchDB) non-IAM based authentication types +must be used.

+

This table summarizes the available authentication types. +The authentication types are listed in order of recommendation, preferably use the authentication type +from the first row in the table that is compatible with your environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Authentication typeRecommended forAUTH_TYPEDescription
IAM Trusted Profiles compute resource (container)Cloudant
(SDK running in IBM Cloud IKS)
CONTAINERObtains a compute resource (CR) token from the container.
Exchanges the CR token for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
IAM Trusted Profiles compute resource (VPC)Cloudant
(SDK running in IBM Cloud VPC)
VPCObtains an identity token from the VPC instance metadata.
Exchanges the identity token for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
IAM API keyCloudantIAMExchanges an IAM API key for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
Session cookieCloudant
(legacy credentials & instances without IAM)

Apache CouchDB
COUCHDB_SESSIONExchanges credentials with /_session endpoint to retrieve a cookie.
Adds Cookie header and content to each HTTP request.
Automatically renews session when needed.
Bearer tokenApache CouchDB
(using JWT authentication)
BEARERTOKENAdds an Authorization: Bearer <token> to each HTTP request.
No token management or renewal.
Also compatible with IAM access tokens managed independently of the SDK.
BasicApache CouchDB
(if cookies are not enabled)
BASICAdds an Authorization: Basic <encoded username and password> header to each HTTP request.
None-NOAUTHNote that this authentication type only works for operations against a database allowing access for unauthenticated users.
+

The default authentication type for the SDK is CONTAINER unless APIKEY configuration is supplied, which changes the default authentication type to IAM.

+

The default service name is CLOUDANT so CLOUDANT_ prefixed names are used in these examples.

+

Any custom service name prefix can be used as long as the matching name is used to instantiate the SDK client +and the same prefix is used for all configuration options.

+

For Cloudant IAM API key authentication, set the following environmental variables by +replacing the <url> and <apikey> with your proper +service credentials. There is no need to set +CLOUDANT_AUTH_TYPE to IAM because it is the default when an APIKEY is set.

+
CLOUDANT_URL=<url>
CLOUDANT_APIKEY=<apikey> +
+ +

For Cloudant IAM Trusted profile compute resource container authentication, set the following environmental variables by +replacing the <url> and <id> with your values. There is no need to set +CLOUDANT_AUTH_TYPE to CONTAINER because it is the default.

+
CLOUDANT_URL=<url>
CLOUDANT_IAM_PROFILE_ID=<id> +
+ +

Alternatively a profile name may be used instead of an ID by replacing CLOUDANT_IAM_PROFILE_ID with CLOUDANT_IAM_PROFILE_NAME.

+

For Cloudant IAM Trusted profile compute resource vpc authentication, set the following environmental variables by +replacing the <url> and <id> with your values.

+
CLOUDANT_AUTH_TYPE=VPC
CLOUDANT_URL=<url>
CLOUDANT_IAM_PROFILE_ID=<id> +
+ +

Alternatively a profile CRN may be used instead of an ID by replacing CLOUDANT_IAM_PROFILE_ID with CLOUDANT_IAM_PROFILE_CRN.

+

For COUCHDB_SESSION authentication, set the following environmental variables +by replacing the <url>, <username> and <password> with your proper +service credentials.

+
CLOUDANT_AUTH_TYPE=COUCHDB_SESSION
CLOUDANT_URL=<url>
CLOUDANT_USERNAME=<username>
CLOUDANT_PASSWORD=<password> +
+ +

To use an external configuration file, the +Cloudant API docs, +or the +general SDK usage information +will guide you.

+

To learn more about how to use programmatic authentication, see the related +documentation in the +Cloudant API docs +or in the +Node.js SDK Core document about authentication.

+

The SDK supports a generalized retry feature that can automatically retry on common errors.

+

The automatic retries section has details on how to enable the retries with default values and customize the retries programmatically or with external configuration.

+

No request timeout is defined, but a 2.5m connect and 2.5m read timeout is set by default. Be sure to set a request timeout appropriate to your application usage and environment. +The request timeout section contains details on how to change the value.

+

Note: System settings may take precedence over configured timeout values.

+

The following code examples +authenticate with the environment variables.

+

Note: This example code assumes that orders database does not exist in your account.

+

This example code creates orders database and adds a new document "example" +into it. To connect, you must set your environment variables with +the service url, authentication type and authentication credentials +of your Cloudant service.

+

Cloudant environment variable naming starts with a service name prefix that identifies your service. +By default, this is CLOUDANT, see the settings in the +authentication with environment variables section.

+

If you would like to rename your Cloudant service from CLOUDANT, +you must use your defined service name as the prefix for all Cloudant related environment variables.

+

Once the environment variables are set, you can try out the code examples.

+
+TypeScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
interface OrderDocument extends CloudantV1.Document {
name?: string;
joined?: string;
_id: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});

// 2. Create a database =========================================================
const exampleDbName = 'orders';

// Try to create database if it doesn't exist
const createDb = client
.putDatabase({ db: exampleDbName })
.then((putDatabaseResult) => {
if (putDatabaseResult.result.ok) {
console.log(`"${exampleDbName}" database created."`);
}
})
.catch((err) => {
if (err.code === 412) {
console.log(
`Cannot create "${exampleDbName}" database, it already exists.`
);
}
});

// 3. Create a document =========================================================
// Create a document object with "example" id
const exampleDocId = 'example';

// Setting `_id` for the document is optional when postDocument function is used for CREATE.
// When `_id` is not provided the server will generate one for your document.
const exampleDocument: OrderDocument = { _id: exampleDocId };

// Add "name" and "joined" fields to the document
exampleDocument.name = 'Bob Smith';
exampleDocument.joined = '2019-01-24T10:42:59.000Z';

// Save the document in the database with "postDocument" function
createDb.then(() => {
client
.postDocument({
db: exampleDbName,
document: exampleDocument,
})
// ==========================================================================
// Note: saving the document can also be done with the "putDocument"
// function. In this case `docId` is required for a CREATE operation:
/*
.putDocument({
db: exampleDbName,
docId: exampleDocId,
document: exampleDocument,
})
*/
// ==========================================================================
.then((createDocumentResponse) => {
// Keeping track of the revision number of the document object
// is necessary for further UPDATE/DELETE operations:
exampleDocument._rev = createDocumentResponse.result.rev;
console.log(
'You have created the document:\n' +
JSON.stringify(exampleDocument, null, 2)
);
});
}); +
+ +
+
+JavaScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const createDbAndDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});

// 2. Create a database =======================================================
const exampleDbName = 'orders';

// Try to create database if it doesn't exist
try {
const putDatabaseResult = (
await client.putDatabase({
db: exampleDbName,
})
).result;
if (putDatabaseResult.ok) {
console.log(`"${exampleDbName}" database created.`);
}
} catch (err) {
if (err.code === 412) {
console.log(
`Cannot create "${exampleDbName}" database, it already exists.`
);
}
}

// 3. Create a document =======================================================
// Create a document object with "example" id
const exampleDocId = 'example';

// Setting `_id` for the document is optional when "postDocument" function is used for CREATE.
// When `_id` is not provided the server will generate one for your document.
const exampleDocument = { _id: exampleDocId };

// Add "name" and "joined" fields to the document
exampleDocument['name'] = 'Bob Smith';
exampleDocument.joined = '2019-01-24T10:42:59.000Z';

// Save the document in the database with "postDocument" function
const createDocumentResponse = await client.postDocument({
db: exampleDbName,
document: exampleDocument,
});

// ==========================================================================
// Note: saving the document can also be done with the "putDocument"
// function. In this case `docId` is required for a CREATE operation:
/* const createDocumentResponse = await client.putDocument({
db: exampleDbName,
docId: exampleDocId,
document: exampleDocument,
}); */
// ==========================================================================

// Keeping track of the revision number of the document object
// is necessary for further UPDATE/DELETE operations:
exampleDocument._rev = createDocumentResponse.result.rev;
console.log(
'You have created the document:\n' +
JSON.stringify(exampleDocument, null, 2)
);
};

if (require.main === module) {
createDbAndDoc();
} +
+ +
+

When you run the code, you see a result similar to the following output.

+
"orders" database created.
+You have created the document:
+{
+  "_id": "example",
+  "name": "Bob Smith",
+  "joined": "2019-01-24T10:42:59.000Z",
+  "_rev": "1-1b403633540686aa32d013fda9041a5d"
+}
+
+ +

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' +database or 'example' document was not found."

+
+Gather database information example +
+TypeScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
// 1. Create a client with `CLOUDANT` default service name =====================
const client = CloudantV1.newInstance({});

// 2. Get server information ====================================================
// call service without parameters:
client.getServerInformation().then((serverInformation) => {
const { version } = serverInformation.result;
console.log(`Server version ${version}`);
});

// 3. Get database information for "orders" ===================================
const dbName = 'orders';

// call service with embedded parameters:
client.getDatabaseInformation({ db: dbName }).then((dbInfo) => {
const documentCount = dbInfo.result.docCount;
const dbNameResult = dbInfo.result.dbName;

// 4. Show document count in database =========================================
console.log(
`Document count in "${dbNameResult}" database is ${documentCount}.`
);
});

// 5. Get "example" document out of the database by document id =====================
const getDocParams: CloudantV1.GetDocumentParams = {
db: dbName,
docId: 'example',
};

// call service with predefined parameters:
client.getDocument(getDocParams).then((documentExample) => {
// result object is defined as a Document here:
const { result } = documentExample;
console.log(
`Document retrieved from database:\n${JSON.stringify(result, null, 2)}`
);
}); +
+ +
+
+JavaScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const getInfoFromExistingDatabase = async () => {
// 1. Create a client with `CLOUDANT` default service name ===================
const client = CloudantV1.newInstance({});

// 2. Get server information ==================================================
// call service without parameters:
const { version } = (await client.getServerInformation()).result;
console.log(`Server version ${version}`);

// 3. Get database information for "orders" =================================
const dbName = 'orders';

// call service with embedded parameters:
const dbInfo = await client.getDatabaseInformation({ db: dbName });
const documentCount = dbInfo.result.docCount;
const dbNameResult = dbInfo.result.dbName;

// 4. Show document count in database =========================================
console.log(
`Document count in "${dbNameResult}" database is ${documentCount}.`
);

// 5. Get "example" document out of the database by document id ===================
const getDocParams = { db: dbName, docId: 'example' };

// call service with predefined parameters:
const documentExample = await client.getDocument(getDocParams);

// result object is defined as a Document here:
const { result } = documentExample;

console.log(
`Document retrieved from database:\n${JSON.stringify(result, null, 2)}`
);
};

if (require.main === module) {
getInfoFromExistingDatabase();
} +
+ +
+
+When you run the code, you see a result similar to the following output. +
Server version 3.2.1
+Document count in "orders" database is 1.
+Document retrieved from database:
+{
+  "_id": "example",
+  "_rev": "1-1b403633540686aa32d013fda9041a5d",
+  "name": "Bob Smith",
+  "joined": "2019-01-24T10:42:59.000Z"
+}
+
+ +

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot update document because either 'orders' +database or 'example' document was not found."

+
+Update code example +
+TypeScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
interface OrderDocument extends CloudantV1.Document {
address?: string;
joined?: string;
_id?: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});
// 2. Update the document =======================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';

// Try to get the document if it previously existed in the database
const getDocParams: CloudantV1.GetDocumentParams = {
docId: 'example',
db: exampleDbName,
};

// ==============================================================================
// Note : for response byte stream use:
/*
const getdocAsStreamParam: CloudantV1.GetDocumentAsStreamParams = {
docId: 'example',
db: exampleDbName,
};
client
.getDocumentAsStream(getdocAsStreamParam)
.then((documentAsByteStream) => {...});
*/
// ==============================================================================

client
.getDocument(getDocParams)
.then((docResult) => {
// using OrderDocument on getDocument result:
const document: OrderDocument = docResult.result;

// Add Bob Smith's address to the document
document.address = '19 Front Street, Darlington, DL5 1TY';

// Remove the joined property from document object
delete document.joined;

// Update the document in the database
client
.postDocument({ db: exampleDbName, document })
// ========================================================================
// Note 1: for request byte stream use:
// .postDocument(
// {db: exampleDbName, document: documentAsByteStream}
// )
// ========================================================================

// ========================================================================
// Note 2: updating the document can also be done with the "putDocument" function.
// `docId` and `rev` are required for an UPDATE operation,
// but `rev` can be provided in the document object as `_rev` too:
/*
.putDocument({
db: exampleDbName,
docId: document._id, // docId is a required parameter
rev: document._rev,
document, // _rev in the document object CAN replace above `rev` parameter
})
*/
// ========================================================================
.then((res) => {
// Keeping track of the latest revision number of the document object
// is necessary for further UPDATE/DELETE operations:
document._rev = res.result.rev;
console.log(
`You have updated the document:\n${JSON.stringify(document, null, 2)}`
);
});
})
.catch((err) => {
if (err.code === 404) {
console.log(
`Cannot update document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}); +
+ +
+
+JavaScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const updateDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});
// 2. Update the document =====================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';

// Try to get the document if it previously existed in the database
try {
const document = (
await client.getDocument({
docId: 'example',
db: exampleDbName,
})
).result;

// ==========================================================================
// Note: for response byte stream use:
/*
const documentAsByteStream = (
await client.getDocumentAsStream({
docId: 'example',
db: exampleDbName,
})
).result;
*/
// ==========================================================================

// Add Bob Smith's address to the document
document.address = '19 Front Street, Darlington, DL5 1TY';

// Remove the joined property from document object
delete document['joined'];

// Keeping track of the latest revision number of the document object
// is necessary for further UPDATE/DELETE operations:
document._rev = (
await client.postDocument({
db: exampleDbName,
document, // _id and _rev MUST be inside the document object
})
).result.rev;

// ==========================================================================
// Note 1: for request byte stream use:
/*
document._rev = (
await client.postDocument({
db: exampleDbName,
document: documentAsByteStream,
})
).result.rev;
*/
// ==========================================================================

// ==========================================================================
// Note 2: updating the document can also be done with the "putDocument" function.
// `docId` and `rev` are required for an UPDATE operation,
// but `rev` can be provided in the document object as `_rev` too:
/*
document._rev = (
await client.putDocument({
db: exampleDbName,
docId: document._id, // docId is a required parameter
rev: document._rev,
document // _rev in the document object CAN replace above `rev` parameter
})
).result.rev;
*/
// ==========================================================================

console.log(
`You have updated the document:\n${JSON.stringify(document, null, 2)}`
);
} catch (err) {
if (err.code === 404) {
console.log(
`Cannot update document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}
};

if (require.main === module) {
updateDoc();
} +
+ +
+
+When you run the code, you see a result similar to the following output. +
You have updated the document:
+{
+  "_id": "example",
+  "_rev": "2-4e2178e85cffb32d38ba4e451f6ca376",
+  "name": "Bob Smith",
+  "address": "19 Front Street, Darlington, DL5 1TY"
+}
+
+ +

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' +database or 'example' document was not found."

+
+Delete code example +
+TypeScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
interface OrderDocument extends CloudantV1.Document {
name?: string;
address?: string;
joined?: string;
_id?: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});

// 2. Delete the document =======================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';
const exampleDocId = 'example';

// Try to get the document if it previously existed in the database
const getDocParams: CloudantV1.GetDocumentParams = {
docId: exampleDocId,
db: exampleDbName,
};

client
.getDocument(getDocParams)
.then((docResult) => {
const document: OrderDocument = docResult.result;

client
.deleteDocument({
db: exampleDbName,
docId: document._id, // `docId` is required for DELETE
rev: document._rev, // `rev` is required for DELETE
})
.then(() => {
console.log('You have deleted the document.');
});
})
.catch((err) => {
if (err.code === 404) {
console.log(
`Cannot delete document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}); +
+ +
+
+JavaScript: +
import { CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const deleteDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});

// 2. Delete the document =====================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';
const exampleDocId = 'example';

// Try to get the document if it previously existed in the database
try {
const document = (
await client.getDocument({
docId: exampleDocId,
db: exampleDbName,
})
).result;

await client.deleteDocument({
db: exampleDbName,
docId: document._id, // `docId` is required for DELETE
rev: document._rev, // `rev` is required for DELETE
});
console.log('You have deleted the document.');
} catch (err) {
if (err.code === 404) {
console.log(
`Cannot delete document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}
};

if (require.main === module) {
deleteDoc();
} +
+ +
+
+When you run the code, you see the following output. +
You have deleted the document.
+
+ +

For a complete list of code examples, see the examples directory.

+

For sample code on handling errors, see +Cloudant API docs.

+

For endpoints that read or write document content it is possible to bypass +usage of the built-in interface with byte streams.

+

Depending on the specific SDK operation it may be possible to:

+
    +
  • accept a user-provided byte stream to send to the server as a request body
  • +
  • return a byte stream of the server response body to the user
  • +
+

Request byte stream can be supplied for NodeJS.ReadableStream or Buffer type parameters +. +For these cases you can pass this byte stream directly to the HTTP request body.

+

Response byte stream is supported in functions with the suffix of AsStream. +The returned byte stream allows the response body to be consumed +without triggering JSON unmarshalling that is typically performed by the SDK.

+

The update document section +contains examples for both request and response byte stream cases.

+

The API reference contains further examples of using byte streams. +They are titled "Example request as stream" and are initially collapsed. +Expand them to see examples of:

+ +
    +
  • Cloudant API docs: +API reference including usage examples for Cloudant Node.js SDK API.
  • +
  • TypeDoc: +Cloudant Node.js SDK API Documentation.
  • +
  • Cloudant docs: +The official documentation page for Cloudant.
  • +
  • Cloudant blog: +Many useful articles about how to optimize Cloudant for common problems.
  • +
+

You can use the SDK directly from JavaScript running in a browser if:

+
    +
  • Polyfills for required Node.js system modules are available.
  • +
  • The server configuration allows cross-origin resource sharing (CORS).
  • +
+

Use either:

+
    +
  • A bundler that includes polyfills for Node.js system modules in the browser.
  • +
  • Or a Node.js compatible browser-based runtime.
  • +
+

The Node.js system modules required are:

+
    +
  • assert
  • +
  • buffer
  • +
  • crypto
  • +
  • fs
  • +
  • http
  • +
  • https
  • +
  • os
  • +
  • path
  • +
  • process
  • +
  • querystring
  • +
  • stream
  • +
  • timers
  • +
  • url
  • +
  • util
  • +
  • vm
  • +
  • zlib
  • +
+

Additionally the SDK or its dependencies need to be able to resolve the globals:

+
    +
  • Buffer
  • +
  • process
  • +
  • Readable
  • +
  • setImmediate and setTimeout
  • +
+

Environment variables:

+
    +
  • NODE_DEBUG (must be resolvable from the process.env even if it is unset)
  • +
+

It may be possible to omit some of these requirements for specific use cases.

+

To allow CORS requests from the SDK in the browser:

+
    +
  1. Configure the server with a CORS origin matching the URL protocol, host and port of the JavaScript application.
  2. +
  3. Either +
      +
    • Configure the server with a CORS headers allow list that includes the default headers plus the SDK's extra headers: + +
    • +
    • Or configure the SDK to remove the extra headers from requests, for example:
      // Set a request interceptor to remove the headers from the requests
      service.getHttpClient().interceptors.request.use(requestConfig => {
      delete requestConfig.headers['User-Agent']
      delete requestConfig.headers['X-IBMCloud-SDK-Analytics']
      return requestConfig;
      });
      // Disable request body compression
      service.setEnableGzipCompression(false); +
      + +
    • +
    +
  4. +
+

The SDK provides a changes feed follower utility (currently beta). +This helper utility connects to the _changes endpoint and returns the individual change items. +It removes some of the complexity of using the _changes endpoint by setting some options automatically +and providing error suppression and retries.

+

Tip: the changes feed often does not meet user expectations or assumptions.

+

Consult the Cloudant changes feed FAQ +to get a better understanding of the limitations and suitable use-cases before using the changes feed in your application.

+

There are two modes of operation:

+
    +
  • Start mode +
      +
    • Fetches the changes from the supplied since sequence (by default the feed will start from now).
    • +
    • Fetches all available changes and then continues listening for new changes indefinitely unless encountering an end condition.
    • +
    • An example use case for this mode is event driven workloads.
    • +
    +
  • +
  • Start one-off mode +
      +
    • Fetches the changes from the supplied since sequence (by default the feed will start from the beginning).
    • +
    • Fetches all available changes and then stops when either there are no further changes pending or encountering an end condition.
    • +
    • An example use case for this mode is ETL style workloads.
    • +
    +
  • +
+

The SDK's model of changes feed options is also used to configure the follower. +However, a subset of the options are invalid as they are configured internally by the implementation. +Supplying these options when instantiating the follower causes an error. +The invalid options are:

+
    +
  • descending
  • +
  • feed
  • +
  • heartbeat
  • +
  • lastEventId - use since instead
  • +
  • timeout
  • +
  • Only the value of _selector is permitted for the filter option. This restriction is because selector +based filters perform better than JavaScript backed filters. Configuring a non-selector based filter will +cause the follower to error.
  • +
+

Note that the limit parameter will terminate the follower at the given number of changes in either +operating mode.

+

The changes follower requires the client to have HTTP timeouts of at least 1 minute and will error during +instantiation if it is insufficient. The default client configuration has sufficiently long timeouts.

+

For use-cases where these configuration limitations are deemed too restrictive then it is recommended to +write code to use the SDK's POST _changes API instead of the follower.

+

By default, the changes follower will suppress transient errors indefinitely and attempt to run to completion or listen forever as +dictated by the operating mode. +For applications where that is not desirable an optional error tolerance duration may be specified to control the time since +the last successful response that transient errors will be suppressed. This can be used, for example, by applications as a grace period +before reporting an error and requiring intervention.

+

There are some additional points to consider for error suppression:

+
    +
  • Errors considered terminal, for example, the database not existing or invalid credentials are never suppressed and will error immediately.
  • +
  • The error suppression duration is not guaranteed to fire immediately after lapsing and should be considered a minimum suppression time.
  • +
  • The changes follower will back-off between retries and as such may remain paused for a short while after the transient errors have resolved.
  • +
  • If the underlying SDK client used to initialize the follower also has retries configured then errors could be suppressed for significantly +longer than the follower's configured error tolerance duration depending on the configuration options.
  • +
+

For both modes:

+
    +
  • The end conditions are: +
      +
    • A terminal error (HTTP codes 400, 401, 403 404).
    • +
    • Transient errors occur for longer than the error tolerance duration. Transient errors are all other HTTP status codes and connection errors.
    • +
    • The number of changes received reaches the configured limit.
    • +
    • The feed is terminated early by calling stop.
    • +
    +
  • +
+

As is true for the _changes endpoint change items have at least once delivery and an individual item +may be received multiple times. When using the follower change items may be repeated even within a limited +number of changes (i.e. using the limit option) this is a minor difference from using limit on the HTTP native API.

+

The follower is not optimized for some use cases and it is not recommended to use it in cases where:

+
    +
  • Setting include_docs and larger document sizes (for example > 10 kiB).
  • +
  • The volume of changes is very high (if the rate of changes in the database exceeds the follower's rate of pulling them it will never catch-up).
  • +
+

In these cases use-case specific control over the number of change requests made and the content size of the responses +may be achieved by using the SDK's POST _changes API.

+

The changes follower does not checkpoint since it has no information about whether a change item has been +processed by the consuming application after being received. It is the application developer's responsibility +to store the sequence IDs to have appropriate checkpoints and to re-initialize the follower with the required +since value after, for example, the application restarts.

+

The frequency and conditions for checkpointing are application specific and some applications may be tolerant +of dropped changes. This section is intended only to provide general guidance on how to avoid missing changes.

+

To guarantee processing of all changes the sequence ID from a change item must not be persisted until after +the processing of the change item by the application has completed. As indicated previously change items are +delivered at least once so application code must be able to handle repeated changes already and it is +preferable to restart from an older since value and receive changes again than risk missing them.

+

The sequence IDs are available on each change item by default, but may be omitted from some change items when +using the seq_interval configuration option. Infrequent sequence IDs may improve performance by reducing +the amount of data that needs to be transferred, but the trade-off is that more changes will be repeated if +it is necessary to resume the changes follower.

+

Extreme care should be taken with persisting sequences if choosing to process change items in parallel as there +is a considerable risk of missing changes on a restart if the sequence is recorded out of order.

+
+TypeScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
import { PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+ +
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example', // Required: the database name.
limit: 100, // Optional: return only 100 changes (including duplicates).
since: '3-g1AG3...' // Optional: start from this sequence ID (e.g. with a value read from persistent storage).
};
const errorTolerance: number = 10000; // 10 second duration to suppress transient errors
const changesFollower: ChangesFollower = new ChangesFollower(
client, // Required: the Cloudant service client instance.
changesParams, // Required: changes feed configuration options dict.
10000 // Optional: suppress transient errors for at least 10 seconds before terminating.
); +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example', // Required: the database name.
limit: 100, // Optional: return only 100 changes (including duplicates).
since: '3-g1AG3...' // Optional: start from this sequence ID (e.g. with a value read from persistent storage).
};
const changesFollower = new ChangesFollower(
client, // Required: the Cloudant service client instance.
changesParams, // Required: changes feed configuration options dict.
10000 // Optional: suppress transient errors for at least 10 seconds before terminating.
); +
+ +
+
+TypeScript: +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+ +
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+ +
+
+TypeScript: +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+ +
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.startOneOff();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
+
+ +
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.startOneOff();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+ +
+
+TypeScript: +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance({});
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams: PostChangesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

// A pipeline to keep processing changes until the follower is stopped or some other stop condition is reached
pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
}); +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance();
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

// A pipeline to keep processing changes until the follower is stopped or some other stop condition is reached
pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
}); +
+ +
+
+TypeScript: +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance({});
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams: PostChangesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.startOneOff();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('All changes done');
})
.catch((err) => {
console.log(err);
});

// use for-async-loop feature for stream
/*
getChangesFromFollower(changesItemsStream);
async function getChangesFromFollower(changesItemsStream: Stream<CloudantV1.ChangesResultItem>) {
for await (const changesItem of changesItemsStream) {
// do something with change item
// write seq to persistent storage for use as since
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc();
}
}
*/ +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance();
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.startOneOff();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('All changes done');
})
.catch((err) => {
console.log(err);
});

// use for-async-loop feature for stream
/*
getChangesFromFollower(changesItemsStream);
async function getChangesFromFollower(changesItemsStream) {
for await (const changesItem of changesItemsStream) {
// do something with change item
// write seq to persistent storage for use as since
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc();
}
}
*/ +
+ +
+
+TypeScript: +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// Option 1: call stop after some condition
// Note that at least one item
// must be returned to reach to this point.
// Additional changes may be processed before the iterator stops.
changesFollower.stop();
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
});

// Option 2: call stop method when you want to end the continuous loop from
// outside the pipeline.
// Normally the call would be made from some other application function
// executing later.
// For example, stop the changesFollower after 1 minute of listening for changes
setTimeout(() => {
changesFollower.stop();
}, 60000); +
+ +
+
+JavaScript: +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+ +
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// Option 1: call stop after some condition
// Note that at least one item
// must be returned to reach to this point.
// Additional changes may be processed before the iterator stops.
changesFollower.stop();
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() =>{
console.log('Stopped');
})
.catch((err) => {
console.log(err);
});

// Option 2: call stop method when you want to end the continuous loop from
// outside the pipeline.
// Normally the call would be made from some other application function
// executing later.
// For example, stop the changesFollower after 1 minute of listening for changes
setTimeout(() => {
changesFollower.stop();
}, 60000); +
+ +
+

If you are having difficulties using this SDK or have a question about the +IBM Cloud services, ask a question on +Stack Overflow.

+

If you encounter an issue with the project, you are welcome to submit a +bug report.

+

Before you submit a bug report, search for +similar issues and review the +KNOWN_ISSUES file to verify that your issue hasn't been reported yet.

+

Please consult the security policy before opening security related issues.

+

This SDK follows semantic versioning with respect to the definition of user facing APIs. +This means under some circumstances breaking changes may occur within a major or minor version +of the SDK related to changes in supported language platforms.

+

The SDK is supported on the available LTS releases of the language platform. +The LTS language versions are listed in the prerequisites:

+ +

Incompatible changes from new language versions are not added to the SDK +until they are available in the minimum supported language version.

+

When language LTS versions move out of support the following will happen:

+
    +
  • Existing SDK releases will continue to run on obsolete language versions, but will no longer be supported.
  • +
  • The minimum language version supported by the SDK will be updated to the next available LTS.
  • +
  • New language features may be added in subsequent SDK releases that will cause breaking changes +if the new releases of the SDK are used with older, now unsupported, language levels.
  • +
+

Find more open source projects on the IBM GitHub page.

+

For more information, see CONTRIBUTING.

+

This SDK is released under the Apache 2.0 license. To read the full text of the license, see LICENSE.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.ActiveTask.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ActiveTask.Transport.html new file mode 100644 index 000000000..65feb965f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ActiveTask.Transport.html @@ -0,0 +1,35 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    bulk_get_attempts?: number;
    bulk_get_docs?: number;
    changes_done?: number;
    changes_pending?: number;
    checkpoint_interval?: number;
    checkpointed_source_seq?: string;
    continuous?: boolean;
    database: string;
    design_document?: string;
    doc_id?: string;
    doc_write_failures?: number;
    docs_read?: number;
    docs_written?: number;
    index?: string;
    indexer_pid?: string;
    missing_revisions_found?: number;
    node: string;
    phase?: string;
    pid: string;
    process_status?: string;
    progress?: number;
    replication_id?: string;
    retry?: boolean;
    revisions_checked?: number;
    source?: string;
    source_seq?: string;
    started_on: number;
    target?: string;
    through_seq?: string;
    total_changes?: number;
    type: string;
    updated_on: number;
    user?: string;
    view?: number;
}

Properties

bulk_get_attempts?: number
bulk_get_docs?: number
changes_done?: number
changes_pending?: number
checkpoint_interval?: number
checkpointed_source_seq?: string
continuous?: boolean
database: string
design_document?: string
doc_id?: string
doc_write_failures?: number
docs_read?: number
docs_written?: number
index?: string
indexer_pid?: string
missing_revisions_found?: number
node: string
phase?: string
pid: string
process_status?: string
progress?: number
replication_id?: string
retry?: boolean
revisions_checked?: number
source?: string
source_seq?: string
started_on: number
target?: string
through_seq?: string
total_changes?: number
type: string
updated_on: number
user?: string
view?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.ActivityTrackerEvents.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ActivityTrackerEvents.Transport.html new file mode 100644 index 000000000..f8f73ad2a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ActivityTrackerEvents.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    types: string[];
}

Properties

Properties

types: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.AllDocsQueriesResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.AllDocsQueriesResult.Transport.html new file mode 100644 index 000000000..5c80a03c9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.AllDocsQueriesResult.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    results: CloudantV1.AllDocsResult[];
}

Properties

Properties

diff --git a/docs/0.12.1/interfaces/CloudantV1.AllDocsQuery.Transport.html b/docs/0.12.1/interfaces/CloudantV1.AllDocsQuery.Transport.html new file mode 100644 index 000000000..bab098d0b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.AllDocsQuery.Transport.html @@ -0,0 +1,14 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    att_encoding_info?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    descending?: boolean;
    end_key?: string;
    include_docs?: boolean;
    inclusive_end?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    start_key?: string;
    update_seq?: boolean;
}

Properties

att_encoding_info?: boolean
attachments?: boolean
conflicts?: boolean
descending?: boolean
end_key?: string
include_docs?: boolean
inclusive_end?: boolean
key?: string
keys?: string[]
limit?: number
skip?: number
start_key?: string
update_seq?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.AllDocsResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.AllDocsResult.Transport.html new file mode 100644 index 000000000..0960a6ba7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.AllDocsResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    rows: CloudantV1.DocsResultRow[];
    total_rows: number;
    update_seq?: string;
}

Properties

total_rows: number
update_seq?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.Analyzer.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Analyzer.Transport.html new file mode 100644 index 000000000..8b56d1244 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Analyzer.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
    stopwords?: string[];
}

Properties

Properties

name: string
stopwords?: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.AnalyzerConfiguration.Transport.html b/docs/0.12.1/interfaces/CloudantV1.AnalyzerConfiguration.Transport.html new file mode 100644 index 000000000..ecbdb4657 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.AnalyzerConfiguration.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    fields?: { [key: string]: CloudantV1.Analyzer.Transport };
    name: string;
    stopwords?: string[];
}

Properties

Properties

fields?: { [key: string]: CloudantV1.Analyzer.Transport }
name: string
stopwords?: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.ApiKeysResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ApiKeysResult.Transport.html new file mode 100644 index 000000000..fe129d30e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ApiKeysResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    key: string;
    ok: boolean;
    password: string;
}

Properties

Properties

key: string
ok: boolean
password: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.Attachment.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Attachment.Transport.html new file mode 100644 index 000000000..9f940705c --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Attachment.Transport.html @@ -0,0 +1,10 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    content_type?: string;
    data?: string;
    digest?: string;
    encoded_length?: number;
    encoding?: string;
    follows?: boolean;
    length?: number;
    revpos?: number;
    stub?: boolean;
}

Properties

content_type?: string
data?: string
digest?: string
encoded_length?: number
encoding?: string
follows?: boolean
length?: number
revpos?: number
stub?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.BulkDocs.Transport.html b/docs/0.12.1/interfaces/CloudantV1.BulkDocs.Transport.html new file mode 100644 index 000000000..2d2c12515 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.BulkDocs.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    docs: CloudantV1.Document[];
    new_edits?: boolean;
}

Properties

Properties

new_edits?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.BulkGetQueryDocument.Transport.html b/docs/0.12.1/interfaces/CloudantV1.BulkGetQueryDocument.Transport.html new file mode 100644 index 000000000..120e3b67a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.BulkGetQueryDocument.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    atts_since?: string[];
    id: string;
    rev?: string;
}

Properties

Properties

atts_since?: string[]
id: string
rev?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.BulkGetResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.BulkGetResult.Transport.html new file mode 100644 index 000000000..1732f3133 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.BulkGetResult.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    results: CloudantV1.BulkGetResultItem[];
}

Properties

Properties

diff --git a/docs/0.12.1/interfaces/CloudantV1.BulkGetResultDocument.Transport.html b/docs/0.12.1/interfaces/CloudantV1.BulkGetResultDocument.Transport.html new file mode 100644 index 000000000..97a2f8097 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.BulkGetResultDocument.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    error?: CloudantV1.DocumentResult.Transport;
    ok?: CloudantV1.Document.Transport;
}

Properties

Properties

diff --git a/docs/0.12.1/interfaces/CloudantV1.BulkGetResultItem.Transport.html b/docs/0.12.1/interfaces/CloudantV1.BulkGetResultItem.Transport.html new file mode 100644 index 000000000..75c1c113f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.BulkGetResultItem.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    docs: CloudantV1.BulkGetResultDocument[];
    id: string;
}

Properties

docs +id +

Properties

id: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformation.Transport.html new file mode 100644 index 000000000..ae29654e6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationCurrent.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationCurrent.Transport.html new file mode 100644 index 000000000..7a51fca8a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationCurrent.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationTarget.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationTarget.Transport.html new file mode 100644 index 000000000..20e6b01ea --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CapacityThroughputInformationTarget.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.Change.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Change.Transport.html new file mode 100644 index 000000000..8a83f6d55 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Change.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    rev: string;
}

Properties

rev +

Properties

rev: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ChangesResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ChangesResult.Transport.html new file mode 100644 index 000000000..32030cbfc --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ChangesResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    last_seq: string;
    pending: number;
    results: CloudantV1.ChangesResultItem[];
}

Properties

Properties

last_seq: string
pending: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.ChangesResultItem.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ChangesResultItem.Transport.html new file mode 100644 index 000000000..33e2283c9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ChangesResultItem.Transport.html @@ -0,0 +1,6 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    changes: CloudantV1.Change[];
    deleted?: boolean;
    doc?: CloudantV1.Document.Transport;
    id: string;
    seq: string;
}

Properties

Properties

changes: CloudantV1.Change[]
deleted?: boolean
id: string
seq: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ContentInformationSizes.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ContentInformationSizes.Transport.html new file mode 100644 index 000000000..bc1c5b907 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ContentInformationSizes.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    active: number;
    external: number;
    file: number;
}

Properties

Properties

active: number
external: number
file: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.CorsInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CorsInformation.Transport.html new file mode 100644 index 000000000..019222ea5 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CorsInformation.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    allow_credentials: boolean;
    enable_cors: boolean;
    origins: string[];
}

Properties

allow_credentials: boolean
enable_cors: boolean
origins: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformation.Transport.html new file mode 100644 index 000000000..6e59253d3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformation.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformationThroughput.Transport.html b/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformationThroughput.Transport.html new file mode 100644 index 000000000..0886d400e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.CurrentThroughputInformationThroughput.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    query: number;
    read: number;
    write: number;
}

Properties

Properties

query: number
read: number
write: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.DatabaseInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformation.Transport.html new file mode 100644 index 000000000..9b93d9da1 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformation.Transport.html @@ -0,0 +1,16 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    cluster: CloudantV1.DatabaseInformationCluster.Transport;
    committed_update_seq?: string;
    compact_running: boolean;
    compacted_seq?: string;
    db_name: string;
    disk_format_version: number;
    doc_count: number;
    doc_del_count: number;
    engine?: string;
    instance_start_time: string;
    partitioned_indexes?: CloudantV1.PartitionedIndexesInformation.Transport;
    props: CloudantV1.DatabaseInformationProps.Transport;
    sizes: CloudantV1.ContentInformationSizes.Transport;
    update_seq: string;
    uuid?: string;
}

Properties

committed_update_seq?: string
compact_running: boolean
compacted_seq?: string
db_name: string
disk_format_version: number
doc_count: number
doc_del_count: number
engine?: string
instance_start_time: string
update_seq: string
uuid?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationCluster.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationCluster.Transport.html new file mode 100644 index 000000000..f285bf771 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationCluster.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    n: number;
    q: number;
    r: number;
    w: number;
}

Properties

n +q +r +w +

Properties

n: number
q: number
r: number
w: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationProps.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationProps.Transport.html new file mode 100644 index 000000000..686f3d23b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DatabaseInformationProps.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    partitioned?: boolean;
}

Properties

Properties

partitioned?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.DbEvent.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DbEvent.Transport.html new file mode 100644 index 000000000..2d6e998a6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DbEvent.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    db_name: string;
    seq: string;
    type: string;
}

Properties

Properties

db_name: string
seq: string
type: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DbUpdates.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DbUpdates.Transport.html new file mode 100644 index 000000000..ad471cfaa --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DbUpdates.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    last_seq: string;
    results: CloudantV1.DbEvent[];
}

Properties

Properties

last_seq: string
results: CloudantV1.DbEvent[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.DbsInfoResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DbsInfoResult.Transport.html new file mode 100644 index 000000000..492f4c55d --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DbsInfoResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    error?: string;
    info?: CloudantV1.DatabaseInformation.Transport;
    key: string;
}

Properties

Properties

error?: string
key: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteAttachmentParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteAttachmentParams.html new file mode 100644 index 000000000..ac0d6f545 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteAttachmentParams.html @@ -0,0 +1,16 @@ +DeleteAttachmentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteAttachment operation.

+
interface DeleteAttachmentParams {
    attachmentName: string;
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

attachmentName: string

Path parameter to specify the attachment name.

+
batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteDatabaseParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteDatabaseParams.html new file mode 100644 index 000000000..9c98a883e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteDatabaseParams.html @@ -0,0 +1,5 @@ +DeleteDatabaseParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteDatabase operation.

+
interface DeleteDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteDesignDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteDesignDocumentParams.html new file mode 100644 index 000000000..f668aa47b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteDesignDocumentParams.html @@ -0,0 +1,15 @@ +DeleteDesignDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteDesignDocument operation.

+
interface DeleteDesignDocumentParams {
    batch?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteDocumentParams.html new file mode 100644 index 000000000..3efdc5b4c --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteDocumentParams.html @@ -0,0 +1,14 @@ +DeleteDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteDocument operation.

+
interface DeleteDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteIndexParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteIndexParams.html new file mode 100644 index 000000000..ee01f7861 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteIndexParams.html @@ -0,0 +1,12 @@ +DeleteIndexParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteIndex operation.

+
interface DeleteIndexParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
    type: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
index: string

Path parameter to specify the index name.

+
type: string

Path parameter to specify the index type.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteLocalDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteLocalDocumentParams.html new file mode 100644 index 000000000..00ff979fb --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteLocalDocumentParams.html @@ -0,0 +1,10 @@ +DeleteLocalDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the deleteLocalDocument operation.

+
interface DeleteLocalDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.DeleteReplicationDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.DeleteReplicationDocumentParams.html new file mode 100644 index 000000000..4195699e7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DeleteReplicationDocumentParams.html @@ -0,0 +1,12 @@ +DeleteReplicationDocumentParams | @ibm-cloud/cloudant - v0.12.1

Interface DeleteReplicationDocumentParams

Parameters for the deleteReplicationDocument operation.

+
interface DeleteReplicationDocumentParams {
    batch?: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
docId: string

Path parameter to specify the ID of the stored replication configuration in the _replicator database.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.DesignDocument.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DesignDocument.Transport.html new file mode 100644 index 000000000..c49f039ec --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DesignDocument.Transport.html @@ -0,0 +1,18 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    _attachments?: { [key: string]: CloudantV1.Attachment.Transport };
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: CloudantV1.Revisions.Transport;
    _revs_info?: CloudantV1.DocumentRevisionStatus[];
    autoupdate?: boolean;
    filters?: JsonObject;
    indexes?: { [key: string]: CloudantV1.SearchIndexDefinition.Transport };
    language?: string;
    options?: CloudantV1.DesignDocumentOptions.Transport;
    validate_doc_update?: string;
    views?: {
        [key: string]: CloudantV1.DesignDocumentViewsMapReduce.Transport;
    };
    [propName: string]: any;
}

Indexable

  • [propName: string]: any

    DesignDocument.DesignDocument.Transport accepts additional properties of type any.

    +

Properties

_attachments?: { [key: string]: CloudantV1.Attachment.Transport }
_conflicts?: string[]
_deleted?: boolean
_deleted_conflicts?: string[]
_id?: string
_local_seq?: string
_rev?: string
autoupdate?: boolean
filters?: JsonObject
indexes?: { [key: string]: CloudantV1.SearchIndexDefinition.Transport }
language?: string
validate_doc_update?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DesignDocumentInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentInformation.Transport.html new file mode 100644 index 000000000..e296a4b96 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
    view_index: CloudantV1.DesignDocumentViewIndex.Transport;
}

Properties

Properties

name: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DesignDocumentOptions.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentOptions.Transport.html new file mode 100644 index 000000000..a107e3391 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentOptions.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    partitioned?: boolean;
}

Properties

Properties

partitioned?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewIndex.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewIndex.Transport.html new file mode 100644 index 000000000..b19e8cac2 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewIndex.Transport.html @@ -0,0 +1,10 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    collator_versions: string[];
    compact_running: boolean;
    language: string;
    signature: string;
    sizes: CloudantV1.ContentInformationSizes.Transport;
    updater_running: boolean;
    updates_pending: CloudantV1.UpdatesPending.Transport;
    waiting_clients: number;
    waiting_commit: boolean;
}

Properties

collator_versions: string[]
compact_running: boolean
language: string
signature: string
updater_running: boolean
waiting_clients: number
waiting_commit: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewsMapReduce.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewsMapReduce.Transport.html new file mode 100644 index 000000000..c0f217fef --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DesignDocumentViewsMapReduce.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    map: string;
    reduce?: string;
}

Properties

Properties

map: string
reduce?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DocsResultRow.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DocsResultRow.Transport.html new file mode 100644 index 000000000..b4b5ad15e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DocsResultRow.Transport.html @@ -0,0 +1,9 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    caused_by?: string;
    doc?: CloudantV1.Document.Transport;
    error?: string;
    id?: string;
    key: string;
    reason?: string;
    ref?: number;
    value?: CloudantV1.DocsResultRowValue.Transport;
}

Properties

caused_by?: string
error?: string
id?: string
key: string
reason?: string
ref?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.DocsResultRowValue.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DocsResultRowValue.Transport.html new file mode 100644 index 000000000..00c2f1a38 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DocsResultRowValue.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    deleted?: boolean;
    rev: string;
}

Properties

Properties

deleted?: boolean
rev: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.Document.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Document.Transport.html new file mode 100644 index 000000000..e3c77bc19 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Document.Transport.html @@ -0,0 +1,11 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    _attachments?: { [key: string]: CloudantV1.Attachment.Transport };
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: CloudantV1.Revisions.Transport;
    _revs_info?: CloudantV1.DocumentRevisionStatus[];
    [propName: string]: any;
}

Indexable

  • [propName: string]: any

    Document.Document.Transport accepts additional properties of type any.

    +

Properties

_attachments?: { [key: string]: CloudantV1.Attachment.Transport }
_conflicts?: string[]
_deleted?: boolean
_deleted_conflicts?: string[]
_id?: string
_local_seq?: string
_rev?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DocumentResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DocumentResult.Transport.html new file mode 100644 index 000000000..fc9379d18 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DocumentResult.Transport.html @@ -0,0 +1,8 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    caused_by?: string;
    error?: string;
    id: string;
    ok?: boolean;
    reason?: string;
    ref?: number;
    rev?: string;
}

Properties

Properties

caused_by?: string
error?: string
id: string
ok?: boolean
reason?: string
ref?: number
rev?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DocumentRevisionStatus.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DocumentRevisionStatus.Transport.html new file mode 100644 index 000000000..e01e0a465 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DocumentRevisionStatus.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    rev: string;
    status: string;
}

Properties

Properties

rev: string
status: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.DocumentShardInfo.Transport.html b/docs/0.12.1/interfaces/CloudantV1.DocumentShardInfo.Transport.html new file mode 100644 index 000000000..0446c3353 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.DocumentShardInfo.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    nodes: string[];
    range: string;
}

Properties

Properties

nodes: string[]
range: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.EmptyObject.html b/docs/0.12.1/interfaces/CloudantV1.EmptyObject.html new file mode 100644 index 000000000..6220049d5 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.EmptyObject.html @@ -0,0 +1,2 @@ +EmptyObject | @ibm-cloud/cloudant - v0.12.1

The body of a service request that returns no response data.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.ExecutionStats.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ExecutionStats.Transport.html new file mode 100644 index 000000000..58778c9a2 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ExecutionStats.Transport.html @@ -0,0 +1,6 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    execution_time_ms: number;
    results_returned: number;
    total_docs_examined: number;
    total_keys_examined: number;
    total_quorum_docs_examined: number;
}

Properties

execution_time_ms: number
results_returned: number
total_docs_examined: number
total_keys_examined: number
total_quorum_docs_examined: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.ExplainResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ExplainResult.Transport.html new file mode 100644 index 000000000..e6cba08e3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ExplainResult.Transport.html @@ -0,0 +1,13 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    covering: boolean;
    dbname: string;
    fields: string[];
    index: CloudantV1.IndexInformation.Transport;
    index_candidates: CloudantV1.IndexCandidate[];
    limit: number;
    mrargs?: CloudantV1.ExplainResultMrArgs.Transport;
    opts: CloudantV1.ExplainResultOpts.Transport;
    partitioned?: any;
    selector: JsonObject;
    selector_hints: CloudantV1.SelectorHint[];
    skip: number;
}

Properties

covering: boolean
dbname: string
fields: string[]
index_candidates: CloudantV1.IndexCandidate[]
limit: number
partitioned?: any
selector: JsonObject
selector_hints: CloudantV1.SelectorHint[]
skip: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.ExplainResultMrArgs.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ExplainResultMrArgs.Transport.html new file mode 100644 index 000000000..63f343dae --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ExplainResultMrArgs.Transport.html @@ -0,0 +1,11 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    conflicts: any;
    direction: string;
    end_key: any;
    include_docs: boolean;
    partition: string;
    reduce: boolean;
    stable: boolean;
    start_key?: any;
    update: any;
    view_type: string;
}

Properties

conflicts: any
direction: string
end_key: any
include_docs: boolean
partition: string
reduce: boolean
stable: boolean
start_key?: any
update: any
view_type: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ExplainResultOpts.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ExplainResultOpts.Transport.html new file mode 100644 index 000000000..35ed1fde7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ExplainResultOpts.Transport.html @@ -0,0 +1,14 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    bookmark: string;
    conflicts: boolean;
    execution_stats: boolean;
    fields: string[];
    limit: number;
    partition: string;
    r: number;
    skip: number;
    sort: any;
    stable: boolean;
    stale: boolean;
    update: boolean;
    use_index: string[];
}

Properties

bookmark: string
conflicts: boolean
execution_stats: boolean
fields: string[]
limit: number
partition: string
r: number
skip: number
sort: any
stable: boolean
stale: boolean
update: boolean
use_index: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.FindResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.FindResult.Transport.html new file mode 100644 index 000000000..98bc7fc44 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.FindResult.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    bookmark: string;
    docs: CloudantV1.Document[];
    execution_stats?: CloudantV1.ExecutionStats.Transport;
    warning?: string;
}

Properties

bookmark: string
warning?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetActiveTasksParams.html b/docs/0.12.1/interfaces/CloudantV1.GetActiveTasksParams.html new file mode 100644 index 000000000..38820c772 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetActiveTasksParams.html @@ -0,0 +1,3 @@ +GetActiveTasksParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getActiveTasks operation.

+
interface GetActiveTasksParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetActivityTrackerEventsParams.html b/docs/0.12.1/interfaces/CloudantV1.GetActivityTrackerEventsParams.html new file mode 100644 index 000000000..9fa0734c3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetActivityTrackerEventsParams.html @@ -0,0 +1,3 @@ +GetActivityTrackerEventsParams | @ibm-cloud/cloudant - v0.12.1

Interface GetActivityTrackerEventsParams

Parameters for the getActivityTrackerEvents operation.

+
interface GetActivityTrackerEventsParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetAllDbsParams.html b/docs/0.12.1/interfaces/CloudantV1.GetAllDbsParams.html new file mode 100644 index 000000000..70bdcfe66 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetAllDbsParams.html @@ -0,0 +1,15 @@ +GetAllDbsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getAllDbs operation.

+
interface GetAllDbsParams {
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
    startKey?: string;
}

Properties

descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Query parameter to specify to stop returning records when the specified key is reached. String +representation of any JSON type that matches the key type emitted by the view function.

+
headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+
startKey?: string

Query parameter to specify to start returning records from the specified key. String representation of any +JSON type that matches the key type emitted by the view function.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetAttachmentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetAttachmentParams.html new file mode 100644 index 000000000..0b13428ee --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetAttachmentParams.html @@ -0,0 +1,20 @@ +GetAttachmentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getAttachment operation.

+
interface GetAttachmentParams {
    accept?: string;
    attachmentName: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    ifNoneMatch?: string;
    range?: string;
    rev?: string;
}

Properties

accept?: string

The type of the response: /.

+
attachmentName: string

Path parameter to specify the attachment name.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
range?: string

Header parameter to specify the byte range for a request. This allows the implementation of resumable +downloads and skippable streams. This is available for all attachments inside CouchDB.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetCapacityThroughputInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetCapacityThroughputInformationParams.html new file mode 100644 index 000000000..49c56f01f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetCapacityThroughputInformationParams.html @@ -0,0 +1,3 @@ +GetCapacityThroughputInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetCapacityThroughputInformationParams

Parameters for the getCapacityThroughputInformation operation.

+
interface GetCapacityThroughputInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetCorsInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetCorsInformationParams.html new file mode 100644 index 000000000..1d1719bf6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetCorsInformationParams.html @@ -0,0 +1,3 @@ +GetCorsInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getCorsInformation operation.

+
interface GetCorsInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetCurrentThroughputInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetCurrentThroughputInformationParams.html new file mode 100644 index 000000000..7e300b390 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetCurrentThroughputInformationParams.html @@ -0,0 +1,3 @@ +GetCurrentThroughputInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetCurrentThroughputInformationParams

Parameters for the getCurrentThroughputInformation operation.

+
interface GetCurrentThroughputInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDatabaseInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDatabaseInformationParams.html new file mode 100644 index 000000000..e0dd20185 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDatabaseInformationParams.html @@ -0,0 +1,5 @@ +GetDatabaseInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetDatabaseInformationParams

Parameters for the getDatabaseInformation operation.

+
interface GetDatabaseInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDbUpdatesParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDbUpdatesParams.html new file mode 100644 index 000000000..93b198dca --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDbUpdatesParams.html @@ -0,0 +1,31 @@ +GetDbUpdatesParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDbUpdates operation.

+
interface GetDbUpdatesParams {
    descending?: boolean;
    feed?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    limit?: number;
    since?: string;
    timeout?: number;
}

Properties

descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
feed?: string

Query parameter to specify the changes feed type.

+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentInformationParams.html new file mode 100644 index 000000000..7be4ae7b6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentInformationParams.html @@ -0,0 +1,8 @@ +GetDesignDocumentInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetDesignDocumentInformationParams

Parameters for the getDesignDocumentInformation operation.

+
interface GetDesignDocumentInformationParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentParams.html new file mode 100644 index 000000000..0ea9069d8 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDesignDocumentParams.html @@ -0,0 +1,35 @@ +GetDesignDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDesignDocument operation.

+
interface GetDesignDocumentParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    deletedConflicts?: boolean;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsMixedParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsMixedParams.html new file mode 100644 index 000000000..af01d1ad1 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsMixedParams.html @@ -0,0 +1,34 @@ +GetDocumentAsMixedParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDocumentAsMixed operation.

+
interface GetDocumentAsMixedParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsRelatedParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsRelatedParams.html new file mode 100644 index 000000000..c02d6fd64 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsRelatedParams.html @@ -0,0 +1,34 @@ +GetDocumentAsRelatedParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDocumentAsRelated operation.

+
interface GetDocumentAsRelatedParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsStreamParams.html new file mode 100644 index 000000000..ef10abbd0 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDocumentAsStreamParams.html @@ -0,0 +1,34 @@ +GetDocumentAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDocumentAsStream operation.

+
interface GetDocumentAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDocumentParams.html new file mode 100644 index 000000000..8233a9f44 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDocumentParams.html @@ -0,0 +1,34 @@ +GetDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDocument operation.

+
interface GetDocumentParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetDocumentShardsInfoParams.html b/docs/0.12.1/interfaces/CloudantV1.GetDocumentShardsInfoParams.html new file mode 100644 index 000000000..0fe8db4dc --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetDocumentShardsInfoParams.html @@ -0,0 +1,7 @@ +GetDocumentShardsInfoParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getDocumentShardsInfo operation.

+
interface GetDocumentShardsInfoParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetIndexesInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetIndexesInformationParams.html new file mode 100644 index 000000000..3aab8e716 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetIndexesInformationParams.html @@ -0,0 +1,5 @@ +GetIndexesInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getIndexesInformation operation.

+
interface GetIndexesInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetLocalDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetLocalDocumentParams.html new file mode 100644 index 000000000..3e1d8ac80 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetLocalDocumentParams.html @@ -0,0 +1,18 @@ +GetLocalDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getLocalDocument operation.

+
interface GetLocalDocumentParams {
    accept?: string;
    attachments?: boolean;
    attEncodingInfo?: boolean;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    localSeq?: boolean;
}

Properties

accept?: string

The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetMembershipInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetMembershipInformationParams.html new file mode 100644 index 000000000..5d814a213 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetMembershipInformationParams.html @@ -0,0 +1,3 @@ +GetMembershipInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetMembershipInformationParams

Parameters for the getMembershipInformation operation.

+
interface GetMembershipInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetPartitionInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetPartitionInformationParams.html new file mode 100644 index 000000000..ceae3594e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetPartitionInformationParams.html @@ -0,0 +1,7 @@ +GetPartitionInformationParams | @ibm-cloud/cloudant - v0.12.1

Interface GetPartitionInformationParams

Parameters for the getPartitionInformation operation.

+
interface GetPartitionInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    partitionKey: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
partitionKey: string

Path parameter to specify the database partition key.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetReplicationDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetReplicationDocumentParams.html new file mode 100644 index 000000000..59e0dddfb --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetReplicationDocumentParams.html @@ -0,0 +1,32 @@ +GetReplicationDocumentParams | @ibm-cloud/cloudant - v0.12.1

Interface GetReplicationDocumentParams

Parameters for the getReplicationDocument operation.

+
interface GetReplicationDocumentParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the +_deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the ID of the stored replication configuration in the _replicator database.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of +the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocsParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocsParams.html new file mode 100644 index 000000000..39d1346a9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocsParams.html @@ -0,0 +1,10 @@ +GetSchedulerDocsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSchedulerDocs operation.

+
interface GetSchedulerDocsParams {
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
    states?: string[] | States[];
}

Properties

Properties

headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+
states?: string[] | States[]

Query parameter to include only replication documents in the specified states. String must be a +comma-delimited string.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocumentParams.html new file mode 100644 index 000000000..6b42e2463 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerDocumentParams.html @@ -0,0 +1,5 @@ +GetSchedulerDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSchedulerDocument operation.

+
interface GetSchedulerDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobParams.html new file mode 100644 index 000000000..8ed505e63 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobParams.html @@ -0,0 +1,5 @@ +GetSchedulerJobParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSchedulerJob operation.

+
interface GetSchedulerJobParams {
    headers?: OutgoingHttpHeaders;
    jobId: string;
}

Properties

Properties

headers?: OutgoingHttpHeaders
jobId: string

Path parameter to specify the replication job id.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobsParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobsParams.html new file mode 100644 index 000000000..73da5a6f1 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSchedulerJobsParams.html @@ -0,0 +1,7 @@ +GetSchedulerJobsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSchedulerJobs operation.

+
interface GetSchedulerJobsParams {
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
}

Properties

Properties

headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned jobs to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSearchDiskSizeParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSearchDiskSizeParams.html new file mode 100644 index 000000000..623338719 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSearchDiskSizeParams.html @@ -0,0 +1,10 @@ +GetSearchDiskSizeParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSearchDiskSize operation.

+
interface GetSearchDiskSizeParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
index: string

Path parameter to specify the index name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSearchInfoParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSearchInfoParams.html new file mode 100644 index 000000000..d1f503342 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSearchInfoParams.html @@ -0,0 +1,10 @@ +GetSearchInfoParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSearchInfo operation.

+
interface GetSearchInfoParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
index: string

Path parameter to specify the index name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSecurityParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSecurityParams.html new file mode 100644 index 000000000..4513be222 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSecurityParams.html @@ -0,0 +1,5 @@ +GetSecurityParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSecurity operation.

+
interface GetSecurityParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetServerInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetServerInformationParams.html new file mode 100644 index 000000000..ef722e26a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetServerInformationParams.html @@ -0,0 +1,3 @@ +GetServerInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getServerInformation operation.

+
interface GetServerInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetSessionInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetSessionInformationParams.html new file mode 100644 index 000000000..78b666ca8 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetSessionInformationParams.html @@ -0,0 +1,3 @@ +GetSessionInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getSessionInformation operation.

+
interface GetSessionInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetShardsInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetShardsInformationParams.html new file mode 100644 index 000000000..7ef33e3db --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetShardsInformationParams.html @@ -0,0 +1,5 @@ +GetShardsInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getShardsInformation operation.

+
interface GetShardsInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetUpInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.GetUpInformationParams.html new file mode 100644 index 000000000..58146bf68 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetUpInformationParams.html @@ -0,0 +1,3 @@ +GetUpInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getUpInformation operation.

+
interface GetUpInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.GetUuidsParams.html b/docs/0.12.1/interfaces/CloudantV1.GetUuidsParams.html new file mode 100644 index 000000000..ef33bdd81 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.GetUuidsParams.html @@ -0,0 +1,5 @@ +GetUuidsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the getUuids operation.

+
interface GetUuidsParams {
    count?: number;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

count?: number

Query parameter to specify the number of UUIDs to return.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadAttachmentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadAttachmentParams.html new file mode 100644 index 000000000..53ae83947 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadAttachmentParams.html @@ -0,0 +1,15 @@ +HeadAttachmentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headAttachment operation.

+
interface HeadAttachmentParams {
    attachmentName: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    ifNoneMatch?: string;
    rev?: string;
}

Properties

attachmentName: string

Path parameter to specify the attachment name.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadDatabaseParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadDatabaseParams.html new file mode 100644 index 000000000..e4f08e59d --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadDatabaseParams.html @@ -0,0 +1,5 @@ +HeadDatabaseParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headDatabase operation.

+
interface HeadDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadDesignDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadDesignDocumentParams.html new file mode 100644 index 000000000..f37ddd1f5 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadDesignDocumentParams.html @@ -0,0 +1,10 @@ +HeadDesignDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headDesignDocument operation.

+
interface HeadDesignDocumentParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadDocumentParams.html new file mode 100644 index 000000000..816a65614 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadDocumentParams.html @@ -0,0 +1,14 @@ +HeadDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headDocument operation.

+
interface HeadDocumentParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    rev?: string;
}

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadLocalDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadLocalDocumentParams.html new file mode 100644 index 000000000..acef2bd6e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadLocalDocumentParams.html @@ -0,0 +1,9 @@ +HeadLocalDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headLocalDocument operation.

+
interface HeadLocalDocumentParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadReplicationDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadReplicationDocumentParams.html new file mode 100644 index 000000000..1ae1065fa --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadReplicationDocumentParams.html @@ -0,0 +1,7 @@ +HeadReplicationDocumentParams | @ibm-cloud/cloudant - v0.12.1

Interface HeadReplicationDocumentParams

Parameters for the headReplicationDocument operation.

+
interface HeadReplicationDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

docId: string

Path parameter to specify the ID of the stored replication configuration in the _replicator database.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter for a conditional HTTP request not matching an ETag.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerDocumentParams.html new file mode 100644 index 000000000..b526256c3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerDocumentParams.html @@ -0,0 +1,5 @@ +HeadSchedulerDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headSchedulerDocument operation.

+
interface HeadSchedulerDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerJobParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerJobParams.html new file mode 100644 index 000000000..45d6be00c --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadSchedulerJobParams.html @@ -0,0 +1,5 @@ +HeadSchedulerJobParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headSchedulerJob operation.

+
interface HeadSchedulerJobParams {
    headers?: OutgoingHttpHeaders;
    jobId: string;
}

Properties

Properties

headers?: OutgoingHttpHeaders
jobId: string

Path parameter to specify the replication job id.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.HeadUpInformationParams.html b/docs/0.12.1/interfaces/CloudantV1.HeadUpInformationParams.html new file mode 100644 index 000000000..a5e8209ac --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.HeadUpInformationParams.html @@ -0,0 +1,3 @@ +HeadUpInformationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the headUpInformation operation.

+
interface HeadUpInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexAnalysis.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexAnalysis.Transport.html new file mode 100644 index 000000000..f7ee0cdab --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexAnalysis.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    covering: boolean;
    ranking: number;
    reasons: CloudantV1.IndexAnalysisExclusionReason[];
    usable: boolean;
}

Properties

covering: boolean
ranking: number
usable: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexAnalysisExclusionReason.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexAnalysisExclusionReason.Transport.html new file mode 100644 index 000000000..86c75de01 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexAnalysisExclusionReason.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
}

Properties

Properties

name: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexCandidate.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexCandidate.Transport.html new file mode 100644 index 000000000..59e676632 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexCandidate.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexDefinition.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexDefinition.Transport.html new file mode 100644 index 000000000..b9eaf88bc --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexDefinition.Transport.html @@ -0,0 +1,6 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    default_analyzer?: CloudantV1.Analyzer.Transport;
    default_field?: CloudantV1.IndexTextOperatorDefaultField.Transport;
    fields: CloudantV1.IndexField[];
    index_array_lengths?: boolean;
    partial_filter_selector?: JsonObject;
}

Properties

default_analyzer?: CloudantV1.Analyzer.Transport
index_array_lengths?: boolean
partial_filter_selector?: JsonObject
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexField.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexField.Transport.html new file mode 100644 index 000000000..25b7c7877 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexField.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name?: string;
    type?: string;
    [propName: string]: any;
}

Indexable

  • [propName: string]: any

    IndexField.IndexField.Transport accepts additional properties of type string.

    +

Properties

Properties

name?: string
type?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexInformation.Transport.html new file mode 100644 index 000000000..4129d9b92 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexInformation.Transport.html @@ -0,0 +1,6 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    ddoc: string;
    def: CloudantV1.IndexDefinition.Transport;
    name: string;
    partitioned?: boolean;
    type: string;
}

Properties

Properties

ddoc: string
name: string
partitioned?: boolean
type: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexResult.Transport.html new file mode 100644 index 000000000..2709bfea7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    id: string;
    name: string;
    result: string;
}

Properties

Properties

id: string
name: string
result: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexTextOperatorDefaultField.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexTextOperatorDefaultField.Transport.html new file mode 100644 index 000000000..9a58a1366 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexTextOperatorDefaultField.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    analyzer?: CloudantV1.Analyzer.Transport;
    enabled?: boolean;
}

Properties

Properties

enabled?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.IndexesInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.IndexesInformation.Transport.html new file mode 100644 index 000000000..284f996aa --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.IndexesInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    indexes: CloudantV1.IndexInformation[];
    total_rows: number;
}

Properties

Properties

total_rows: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.MembershipInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.MembershipInformation.Transport.html new file mode 100644 index 000000000..12f5a9587 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.MembershipInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    all_nodes: string[];
    cluster_nodes: string[];
}

Properties

all_nodes: string[]
cluster_nodes: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.Ok.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Ok.Transport.html new file mode 100644 index 000000000..2f3783731 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Ok.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    ok?: boolean;
}

Properties

ok? +

Properties

ok?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionInformation.Transport.html new file mode 100644 index 000000000..ee0a6499f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionInformation.Transport.html @@ -0,0 +1,7 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    db_name: string;
    doc_count: number;
    doc_del_count: number;
    partition: string;
    partitioned_indexes?: CloudantV1.PartitionInformationIndexes.Transport;
    sizes: CloudantV1.PartitionInformationSizes.Transport;
}

Properties

db_name: string
doc_count: number
doc_del_count: number
partition: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexes.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexes.Transport.html new file mode 100644 index 000000000..e01f6d815 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexes.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    count?: number;
    indexes?: CloudantV1.PartitionInformationIndexesIndexes.Transport;
    limit?: number;
}

Properties

Properties

count?: number
limit?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexesIndexes.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexesIndexes.Transport.html new file mode 100644 index 000000000..933160d41 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationIndexesIndexes.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    search?: number;
    view?: number;
}

Properties

Properties

search?: number
view?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionInformationSizes.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationSizes.Transport.html new file mode 100644 index 000000000..3e2e2a9ca --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionInformationSizes.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    active?: number;
    external?: number;
}

Properties

Properties

active?: number
external?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesDetailedInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesDetailedInformation.Transport.html new file mode 100644 index 000000000..7addd1a6a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesDetailedInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    search?: number;
    view?: number;
}

Properties

Properties

search?: number
view?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesInformation.Transport.html new file mode 100644 index 000000000..eb6eb85c1 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PartitionedIndexesInformation.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    count?: number;
    indexes?: CloudantV1.PartitionedIndexesDetailedInformation.Transport;
    limit?: number;
}

Properties

Properties

count?: number
limit?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostActivityTrackerEventsParams.html b/docs/0.12.1/interfaces/CloudantV1.PostActivityTrackerEventsParams.html new file mode 100644 index 000000000..e1c35e334 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostActivityTrackerEventsParams.html @@ -0,0 +1,6 @@ +PostActivityTrackerEventsParams | @ibm-cloud/cloudant - v0.12.1

Interface PostActivityTrackerEventsParams

Parameters for the postActivityTrackerEvents operation.

+
interface PostActivityTrackerEventsParams {
    headers?: OutgoingHttpHeaders;
    types: string[] | CloudantV1.PostActivityTrackerEventsConstants.Types[];
}

Properties

Properties

headers?: OutgoingHttpHeaders

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. +"management" is a required element of this array.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostAllDocsAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsAsStreamParams.html new file mode 100644 index 000000000..5b08a628b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsAsStreamParams.html @@ -0,0 +1,34 @@ +PostAllDocsAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postAllDocsAsStream operation.

+
interface PostAllDocsAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostAllDocsParams.html b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsParams.html new file mode 100644 index 000000000..071d2fc61 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsParams.html @@ -0,0 +1,34 @@ +PostAllDocsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postAllDocs operation.

+
interface PostAllDocsParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesAsStreamParams.html new file mode 100644 index 000000000..ee874fe23 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesAsStreamParams.html @@ -0,0 +1,8 @@ +PostAllDocsQueriesAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostAllDocsQueriesAsStreamParams

Parameters for the postAllDocsQueriesAsStream operation.

+
interface PostAllDocsQueriesAsStreamParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: CloudantV1.AllDocsQuery[];
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesParams.html b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesParams.html new file mode 100644 index 000000000..2ff2a8485 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostAllDocsQueriesParams.html @@ -0,0 +1,8 @@ +PostAllDocsQueriesParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postAllDocsQueries operation.

+
interface PostAllDocsQueriesParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: CloudantV1.AllDocsQuery[];
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostApiKeysParams.html b/docs/0.12.1/interfaces/CloudantV1.PostApiKeysParams.html new file mode 100644 index 000000000..29c5f06e5 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostApiKeysParams.html @@ -0,0 +1,3 @@ +PostApiKeysParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postApiKeys operation.

+
interface PostApiKeysParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostBulkDocsParams.html b/docs/0.12.1/interfaces/CloudantV1.PostBulkDocsParams.html new file mode 100644 index 000000000..a5c0e56e9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostBulkDocsParams.html @@ -0,0 +1,7 @@ +PostBulkDocsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postBulkDocs operation.

+
interface PostBulkDocsParams {
    bulkDocs: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.BulkDocs;
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

bulkDocs: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.BulkDocs

HTTP request body for postBulkDocs.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsMixedParams.html b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsMixedParams.html new file mode 100644 index 000000000..0b120f760 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsMixedParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsMixedParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postBulkGetAsMixed operation.

+
interface PostBulkGetAsMixedParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    db: string;
    docs: CloudantV1.BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsRelatedParams.html b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsRelatedParams.html new file mode 100644 index 000000000..1a41dfdaf --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsRelatedParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsRelatedParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postBulkGetAsRelated operation.

+
interface PostBulkGetAsRelatedParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    db: string;
    docs: CloudantV1.BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsStreamParams.html new file mode 100644 index 000000000..c2ea2658a --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetAsStreamParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postBulkGetAsStream operation.

+
interface PostBulkGetAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    db: string;
    docs: CloudantV1.BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostBulkGetParams.html b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetParams.html new file mode 100644 index 000000000..939fd2807 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostBulkGetParams.html @@ -0,0 +1,17 @@ +PostBulkGetParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postBulkGet operation.

+
interface PostBulkGetParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    db: string;
    docs: CloudantV1.BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was +requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostChangesAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostChangesAsStreamParams.html new file mode 100644 index 000000000..5d1d150eb --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostChangesAsStreamParams.html @@ -0,0 +1,113 @@ +PostChangesAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postChangesAsStream operation.

+
interface PostChangesAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    docIds?: string[];
    feed?: string;
    fields?: string[];
    filter?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    includeDocs?: boolean;
    lastEventId?: string;
    limit?: number;
    selector?: JsonObject;
    seqInterval?: number;
    since?: string;
    style?: string;
    timeout?: number;
    view?: string;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
docIds?: string[]

Schema for a list of document IDs.

+
feed?: string

Query parameter to specify the changes feed type.

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
filter?: string

Query parameter to specify a filter to emit only specific events from the changes stream.

+

The built-in filter types are:

+
    +
  • _design - Returns only changes to design documents.
  • +
  • _doc_ids - Returns changes for documents with an ID matching one specified in +doc_ids request body parameter. (POST only)
  • +
  • _selector - Returns changes for documents that match the selector +request body parameter. The selector syntax is the same as used for +_find. (POST only)
  • +
  • _view - Returns changes for documents that match an existing map +function in the view specified by the query parameter view.
  • +
+

Additionally, the value can be the name of a JS filter function from a design document. For example: +design_doc/filtername.

+

Note: For better performance use the built-in _selector, _design or _doc_ids filters rather than JS +based _view or design document filters. If you need to pass values to change the filtered content use the +_selector filter type.

+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
includeDocs?: boolean

Query parameter to specify whether to include the full content of the documents in the response.

+
lastEventId?: string

Header parameter to specify the ID of the last events received by the server on a previous connection. +Overrides since query parameter.

+
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
seqInterval?: number

Query parameter to specify that the update seq should only be calculated with every Nth result returned. +When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> +is the number of results requested per batch, load can be reduced on the source database as computing the seq +value across many shards (especially in highly-sharded databases) is expensive.

+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
style?: string

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, +will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts +and deleted former conflicts).

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

+
view?: string

Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function +emits at least one record for them.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostChangesParams.html b/docs/0.12.1/interfaces/CloudantV1.PostChangesParams.html new file mode 100644 index 000000000..40b5ef0a8 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostChangesParams.html @@ -0,0 +1,113 @@ +PostChangesParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postChanges operation.

+
interface PostChangesParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    docIds?: string[];
    feed?: string;
    fields?: string[];
    filter?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    includeDocs?: boolean;
    lastEventId?: string;
    limit?: number;
    selector?: JsonObject;
    seqInterval?: number;
    since?: string;
    style?: string;
    timeout?: number;
    view?: string;
}

Properties

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. +Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
docIds?: string[]

Schema for a list of document IDs.

+
feed?: string

Query parameter to specify the changes feed type.

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
filter?: string

Query parameter to specify a filter to emit only specific events from the changes stream.

+

The built-in filter types are:

+
    +
  • _design - Returns only changes to design documents.
  • +
  • _doc_ids - Returns changes for documents with an ID matching one specified in +doc_ids request body parameter. (POST only)
  • +
  • _selector - Returns changes for documents that match the selector +request body parameter. The selector syntax is the same as used for +_find. (POST only)
  • +
  • _view - Returns changes for documents that match an existing map +function in the view specified by the query parameter view.
  • +
+

Additionally, the value can be the name of a JS filter function from a design document. For example: +design_doc/filtername.

+

Note: For better performance use the built-in _selector, _design or _doc_ids filters rather than JS +based _view or design document filters. If you need to pass values to change the filtered content use the +_selector filter type.

+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off +by default and only applicable for +continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be +true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an +environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. +Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
includeDocs?: boolean

Query parameter to specify whether to include the full content of the documents in the response.

+
lastEventId?: string

Header parameter to specify the ID of the last events received by the server on a previous connection. +Overrides since query parameter.

+
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
seqInterval?: number

Query parameter to specify that the update seq should only be calculated with every Nth result returned. +When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> +is the number of results requested per batch, load can be reduced on the source database as computing the seq +value across many shards (especially in highly-sharded databases) is expensive.

+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. +Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
style?: string

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, +will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts +and deleted former conflicts).

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is +sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is +specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum +timeout to prevent undetected dead connections.

+
view?: string

Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function +emits at least one record for them.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostDbsInfoParams.html b/docs/0.12.1/interfaces/CloudantV1.PostDbsInfoParams.html new file mode 100644 index 000000000..a27fa5bf6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostDbsInfoParams.html @@ -0,0 +1,5 @@ +PostDbsInfoParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postDbsInfo operation.

+
interface PostDbsInfoParams {
    headers?: OutgoingHttpHeaders;
    keys: string[];
}

Properties

Properties

headers?: OutgoingHttpHeaders
keys: string[]

A list of database names.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsParams.html b/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsParams.html new file mode 100644 index 000000000..f864156b6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsParams.html @@ -0,0 +1,34 @@ +PostDesignDocsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postDesignDocs operation.

+
interface PostDesignDocsParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsQueriesParams.html b/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsQueriesParams.html new file mode 100644 index 000000000..d6338e42f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostDesignDocsQueriesParams.html @@ -0,0 +1,10 @@ +PostDesignDocsQueriesParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postDesignDocsQueries operation.

+
interface PostDesignDocsQueriesParams {
    accept?: string;
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: CloudantV1.AllDocsQuery[];
}

Properties

Properties

accept?: string

The type of the response: application/json or application/octet-stream.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.PostDocumentParams.html new file mode 100644 index 000000000..c40da2077 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostDocumentParams.html @@ -0,0 +1,12 @@ +PostDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postDocument operation.

+
interface PostDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document;
    headers?: OutgoingHttpHeaders;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostExplainParams.html b/docs/0.12.1/interfaces/CloudantV1.PostExplainParams.html new file mode 100644 index 000000000..c4ad5bf61 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostExplainParams.html @@ -0,0 +1,81 @@ +PostExplainParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postExplain operation.

+
interface PostExplainParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostFindAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostFindAsStreamParams.html new file mode 100644 index 000000000..8175e8180 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostFindAsStreamParams.html @@ -0,0 +1,81 @@ +PostFindAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postFindAsStream operation.

+
interface PostFindAsStreamParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostFindParams.html b/docs/0.12.1/interfaces/CloudantV1.PostFindParams.html new file mode 100644 index 000000000..cb0378bbd --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostFindParams.html @@ -0,0 +1,81 @@ +PostFindParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postFind operation.

+
interface PostFindParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was +found in the index is returned. If set to a higher value, each document is read from at least that many replicas +before it is returned in the results. The request will take more time than using only the document that is +stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostIndexParams.html b/docs/0.12.1/interfaces/CloudantV1.PostIndexParams.html new file mode 100644 index 000000000..7a47570d9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostIndexParams.html @@ -0,0 +1,22 @@ +PostIndexParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postIndex operation.

+
interface PostIndexParams {
    db: string;
    ddoc?: string;
    headers?: OutgoingHttpHeaders;
    index: CloudantV1.IndexDefinition;
    name?: string;
    partitioned?: boolean;
    type?: string;
}

Properties

db: string

Path parameter to specify the database name.

+
ddoc?: string

Specifies the design document name in which the index will be created. The design document name is the +design document ID excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders

Schema for a json or text query index definition. Indexes of type text have additional configuration +properties that do not apply to json indexes, these are:

+
    +
  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all +document fields and what analyzer to use for that purpose.
  • +
+
name?: string

name.

+
partitioned?: boolean

The default value is true for databases with partitioned: true and false otherwise. For databases with +partitioned: false if this option is specified the value must be false.

+
type?: string

Schema for the type of an index.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsAsStreamParams.html new file mode 100644 index 000000000..81e6b56cf --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsAsStreamParams.html @@ -0,0 +1,36 @@ +PostPartitionAllDocsAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostPartitionAllDocsAsStreamParams

Parameters for the postPartitionAllDocsAsStream operation.

+
interface PostPartitionAllDocsAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    partitionKey: string;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsParams.html new file mode 100644 index 000000000..c91f502a5 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionAllDocsParams.html @@ -0,0 +1,36 @@ +PostPartitionAllDocsParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postPartitionAllDocs operation.

+
interface PostPartitionAllDocsParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    partitionKey: string;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionExplainParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionExplainParams.html new file mode 100644 index 000000000..1843fe9d9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionExplainParams.html @@ -0,0 +1,78 @@ +PostPartitionExplainParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postPartitionExplain operation.

+
interface PostPartitionExplainParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindAsStreamParams.html new file mode 100644 index 000000000..1ed3d2f64 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindAsStreamParams.html @@ -0,0 +1,78 @@ +PostPartitionFindAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostPartitionFindAsStreamParams

Parameters for the postPartitionFindAsStream operation.

+
interface PostPartitionFindAsStreamParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindParams.html new file mode 100644 index 000000000..1a727fdd3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionFindParams.html @@ -0,0 +1,78 @@ +PostPartitionFindParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postPartitionFind operation.

+
interface PostPartitionFindParams {
    allowFallback?: boolean;
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

allowFallback?: boolean

Whether to allow fallback to other indexes. Default is true.

+
bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the +document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key +lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each +document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be +returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and +provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended +option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for +those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A +combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For +instance, the basic $eq operator matches when the specified field contains a value that is equal to the +supplied argument.
  • +
+

It is important for query performance to use appropriate selectors:

+
    +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the +basis of a query. You should include at least one of these in a selector.
  • +
  • Some operators such as $not, $or, $in, and $regex cannot be answered from an index. For query +selectors use these operators in conjunction with equality operators or create and use a partial index to reduce +the number of documents that will need to be scanned.
  • +
+

See the Cloudant Docsfor a list of all available +combination and conditional operators.

+

For further reference see selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The +first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next +level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the +same order and each object in the sort array has a single key or at least one of the sort fields is included in +the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index to answer the query, rather than letting the IBM Cloudant query +planner choose an index. Specified as a two element array of design document id followed by index name, for +example ["my_design_doc", "my_index"].

+

It’s recommended to specify indexes explicitly in your queries to prevent existing queries being affected by new +indexes that might get added later.

+

If the specified index doesn't exist or can't answer the query then the server ignores the value and answers +using another index or a full scan of all documents. To change this behavior set allow_fallback to false and +the server responds instead with a 400 status code if the requested index is unsuitable to answer the query.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchAsStreamParams.html new file mode 100644 index 000000000..18c5c2b67 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchAsStreamParams.html @@ -0,0 +1,45 @@ +PostPartitionSearchAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostPartitionSearchAsStreamParams

Parameters for the postPartitionSearchAsStream operation.

+
interface PostPartitionSearchAsStreamParams {
    bookmark?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    partitionKey: string;
    query: string;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
partitionKey: string

Path parameter to specify the database partition key.

+
query: string

The Lucene query to execute.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchParams.html new file mode 100644 index 000000000..04b164ed1 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionSearchParams.html @@ -0,0 +1,45 @@ +PostPartitionSearchParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postPartitionSearch operation.

+
interface PostPartitionSearchParams {
    bookmark?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    partitionKey: string;
    query: string;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
partitionKey: string

Path parameter to specify the database partition key.

+
query: string

The Lucene query to execute.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewAsStreamParams.html new file mode 100644 index 000000000..2da60072b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewAsStreamParams.html @@ -0,0 +1,66 @@ +PostPartitionViewAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostPartitionViewAsStreamParams

Parameters for the postPartitionViewAsStream operation.

+
interface PostPartitionViewAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    partitionKey: string;
    reduce?: boolean;
    skip?: number;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

+

A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

+

Be aware that include_docs=true can only be used with map views.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewParams.html b/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewParams.html new file mode 100644 index 000000000..1150d0b60 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostPartitionViewParams.html @@ -0,0 +1,66 @@ +PostPartitionViewParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postPartitionView operation.

+
interface PostPartitionViewParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    partitionKey: string;
    reduce?: boolean;
    skip?: number;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

+

A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

+

Be aware that include_docs=true can only be used with map views.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostReplicatorParams.html b/docs/0.12.1/interfaces/CloudantV1.PostReplicatorParams.html new file mode 100644 index 000000000..9cbac2cfe --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostReplicatorParams.html @@ -0,0 +1,8 @@ +PostReplicatorParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postReplicator operation.

+
interface PostReplicatorParams {
    batch?: string;
    headers?: OutgoingHttpHeaders;
    replicationDocument: CloudantV1.ReplicationDocument;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
headers?: OutgoingHttpHeaders
replicationDocument: CloudantV1.ReplicationDocument

HTTP request body for replication operations.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostRevsDiffParams.html b/docs/0.12.1/interfaces/CloudantV1.PostRevsDiffParams.html new file mode 100644 index 000000000..bcf688457 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostRevsDiffParams.html @@ -0,0 +1,7 @@ +PostRevsDiffParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postRevsDiff operation.

+
interface PostRevsDiffParams {
    db: string;
    documentRevisions: JsonObject;
    headers?: OutgoingHttpHeaders;
}

Properties

db: string

Path parameter to specify the database name.

+
documentRevisions: JsonObject

HTTP request body for operations with Document revisions.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostSearchAnalyzeParams.html b/docs/0.12.1/interfaces/CloudantV1.PostSearchAnalyzeParams.html new file mode 100644 index 000000000..48165d421 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostSearchAnalyzeParams.html @@ -0,0 +1,7 @@ +PostSearchAnalyzeParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postSearchAnalyze operation.

+
interface PostSearchAnalyzeParams {
    analyzer: string;
    headers?: OutgoingHttpHeaders;
    text: string;
}

Properties

Properties

analyzer: string

The analyzer type that is being used at the tokenization.

+
headers?: OutgoingHttpHeaders
text: string

The text to tokenize with the analyzer.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostSearchAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostSearchAsStreamParams.html new file mode 100644 index 000000000..cd3c8fa18 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostSearchAsStreamParams.html @@ -0,0 +1,67 @@ +PostSearchAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postSearchAsStream operation.

+
interface PostSearchAsStreamParams {
    bookmark?: string;
    counts?: string[];
    db: string;
    ddoc: string;
    drilldown?: string[][];
    groupField?: string;
    groupLimit?: number;
    groupSort?: string[];
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    query: string;
    ranges?: JsonObject;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
counts?: string[]

This field defines an array of names of string fields, for which counts are requested. The response contains +counts for each unique value of this field name among the documents that match the search query. Faceting must +be enabled for this parameter to function. This option is only available when making global queries.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
drilldown?: string[][]

Restrict results to documents with a dimension equal to the specified label(s). The search matches only +documents containing the value that was provided in the named field. It differs from using "fieldname:value" in +the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to +function.

+
groupField?: string

Field by which to group search matches. A string that contains the name of a string field. Fields containing +other data such as numbers, objects, or arrays cannot be used. This option is only available when making global +queries.

+
groupLimit?: number

Maximum group count. This field can be used only if group_field is specified. This option is only available +when making global queries.

+
groupSort?: string[]

This field defines the order of the groups in a search that uses group_field. The default sort order is +relevance. This field can have the same values as the sort field, so single fields and arrays of fields are +supported. This option is only available when making global queries.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
query: string

The Lucene query to execute.

+
ranges?: JsonObject

Object mapping faceted, numeric search field names to the required ranges. Each key is a field name and each +value is another object defining the ranges by mapping range name keys to string values describing the numeric +ranges, for example "[0 TO 10]". This option is only available when making global queries.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostSearchParams.html b/docs/0.12.1/interfaces/CloudantV1.PostSearchParams.html new file mode 100644 index 000000000..492923726 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostSearchParams.html @@ -0,0 +1,67 @@ +PostSearchParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postSearch operation.

+
interface PostSearchParams {
    bookmark?: string;
    counts?: string[];
    db: string;
    ddoc: string;
    drilldown?: string[][];
    groupField?: string;
    groupLimit?: number;
    groupSort?: string[];
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    query: string;
    ranges?: JsonObject;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
counts?: string[]

This field defines an array of names of string fields, for which counts are requested. The response contains +counts for each unique value of this field name among the documents that match the search query. Faceting must +be enabled for this parameter to function. This option is only available when making global queries.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
drilldown?: string[][]

Restrict results to documents with a dimension equal to the specified label(s). The search matches only +documents containing the value that was provided in the named field. It differs from using "fieldname:value" in +the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to +function.

+
groupField?: string

Field by which to group search matches. A string that contains the name of a string field. Fields containing +other data such as numbers, objects, or arrays cannot be used. This option is only available when making global +queries.

+
groupLimit?: number

Maximum group count. This field can be used only if group_field is specified. This option is only available +when making global queries.

+
groupSort?: string[]

This field defines the order of the groups in a search that uses group_field. The default sort order is +relevance. This field can have the same values as the sort field, so single fields and arrays of fields are +supported. This option is only available when making global queries.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an +entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of +fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with +the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
query: string

The Lucene query to execute.

+
ranges?: JsonObject

Object mapping faceted, numeric search field names to the required ranges. Each key is a field name and each +value is another object defining the ranges by mapping range name keys to string values describing the numeric +ranges, for example "[0 TO 10]". This option is only available when making global queries.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter +specifies the sort order within a group. The default sort order is relevance. A JSON string of the form +"fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a +string or number field, and type is either a number, a string, or a JSON array of strings. The type part is +optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and +["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed +fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostViewAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostViewAsStreamParams.html new file mode 100644 index 000000000..dc06c1f2b --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostViewAsStreamParams.html @@ -0,0 +1,70 @@ +PostViewAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postViewAsStream operation.

+
interface PostViewAsStreamParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

+

A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

+

Be aware that include_docs=true can only be used with map views.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value +false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true +when used in conjunction with update=false may improve consistency at the expense of increased latency and +decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostViewParams.html b/docs/0.12.1/interfaces/CloudantV1.PostViewParams.html new file mode 100644 index 000000000..488f9b42d --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostViewParams.html @@ -0,0 +1,70 @@ +PostViewParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postView operation.

+
interface PostViewParams {
    attachments?: boolean;
    attEncodingInfo?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular +attachment is compressed.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active +only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the +view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the +number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. +Implies group is true. Group level groups the reduced results by the specified number of array elements. If +unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys +that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce +function is defined.

+

A default reduce view type can be disabled to behave like a map by setting reduce=false explicitly.

+

Be aware that include_docs=true can only be used with map views.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value +false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true +when used in conjunction with update=false may improve consistency at the expense of increased latency and +decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of +the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesAsStreamParams.html b/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesAsStreamParams.html new file mode 100644 index 000000000..b523905b2 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesAsStreamParams.html @@ -0,0 +1,13 @@ +PostViewQueriesAsStreamParams | @ibm-cloud/cloudant - v0.12.1

Interface PostViewQueriesAsStreamParams

Parameters for the postViewQueriesAsStream operation.

+
interface PostViewQueriesAsStreamParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    queries: CloudantV1.ViewQuery[];
    view: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders

An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular view request.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesParams.html b/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesParams.html new file mode 100644 index 000000000..48d966e45 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PostViewQueriesParams.html @@ -0,0 +1,13 @@ +PostViewQueriesParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the postViewQueries operation.

+
interface PostViewQueriesParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    queries: CloudantV1.ViewQuery[];
    view: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders

An array of query objects with fields for the parameters of each individual view query to be executed. The +field names and their meaning are the same as the query parameters of a regular view request.

+
view: string

Path parameter to specify the map reduce view function name.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutAttachmentParams.html b/docs/0.12.1/interfaces/CloudantV1.PutAttachmentParams.html new file mode 100644 index 000000000..9e0de42db --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutAttachmentParams.html @@ -0,0 +1,17 @@ +PutAttachmentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putAttachment operation.

+
interface PutAttachmentParams {
    attachment: Buffer<ArrayBufferLike> | ReadableStream;
    attachmentName: string;
    contentType: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

attachment: Buffer<ArrayBufferLike> | ReadableStream

HTTP request body for attachment operations.

+
attachmentName: string

Path parameter to specify the attachment name.

+
contentType: string

Content-Type of the attachment.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutCapacityThroughputConfigurationParams.html b/docs/0.12.1/interfaces/CloudantV1.PutCapacityThroughputConfigurationParams.html new file mode 100644 index 000000000..53f671792 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutCapacityThroughputConfigurationParams.html @@ -0,0 +1,6 @@ +PutCapacityThroughputConfigurationParams | @ibm-cloud/cloudant - v0.12.1

Interface PutCapacityThroughputConfigurationParams

Parameters for the putCapacityThroughputConfiguration operation.

+
interface PutCapacityThroughputConfigurationParams {
    blocks: number;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

blocks: number

A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global +queries/sec of provisioned throughput capacity. Not available for some plans.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutCloudantSecurityConfigurationParams.html b/docs/0.12.1/interfaces/CloudantV1.PutCloudantSecurityConfigurationParams.html new file mode 100644 index 000000000..4b0d81cd3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutCloudantSecurityConfigurationParams.html @@ -0,0 +1,13 @@ +PutCloudantSecurityConfigurationParams | @ibm-cloud/cloudant - v0.12.1

Interface PutCloudantSecurityConfigurationParams

Parameters for the putCloudantSecurityConfiguration operation.

+
interface PutCloudantSecurityConfigurationParams {
    admins?: CloudantV1.SecurityObject;
    cloudant: JsonObject;
    couchdbAuthOnly?: boolean;
    db: string;
    headers?: OutgoingHttpHeaders;
    members?: CloudantV1.SecurityObject;
}

Properties

Schema for names and roles to map to a database permission.

+
cloudant: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdbAuthOnly?: boolean

Manage permissions using the _users database only.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Schema for names and roles to map to a database permission.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutCorsConfigurationParams.html b/docs/0.12.1/interfaces/CloudantV1.PutCorsConfigurationParams.html new file mode 100644 index 000000000..297e1a0b2 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutCorsConfigurationParams.html @@ -0,0 +1,12 @@ +PutCorsConfigurationParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putCorsConfiguration operation.

+
interface PutCorsConfigurationParams {
    allowCredentials?: boolean;
    enableCors?: boolean;
    headers?: OutgoingHttpHeaders;
    origins: string[];
}

Properties

allowCredentials?: boolean

Boolean value to allow authentication credentials. If set to true, browser requests must be done by using +withCredentials = true.

+
enableCors?: boolean

Boolean value to turn CORS on and off.

+
headers?: OutgoingHttpHeaders
origins: string[]

An array of strings that contain allowed origin domains. You have to specify the full URL including the +protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you +have to specify all subdomains used.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutDatabaseParams.html b/docs/0.12.1/interfaces/CloudantV1.PutDatabaseParams.html new file mode 100644 index 000000000..d9f228f10 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutDatabaseParams.html @@ -0,0 +1,15 @@ +PutDatabaseParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putDatabase operation.

+
interface PutDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    partitioned?: boolean;
    q?: number;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
partitioned?: boolean

Query parameter to specify whether to enable database partitions when creating a database.

+

Before using read the +FAQs +to understand the limitations and appropriate use cases.

+
q?: number

The number of shards in the database. Each shard is a partition of the hash value range. Cloudant recommends +using the default value for most databases. However, if your database is expected to be larger than 250 GB or +have a lot of indexes, you may need to adjust the settings. In these cases, it's best to reach out to IBM +Cloudant customer support for guidance on how to meet your specific needs and requirements.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutDesignDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.PutDesignDocumentParams.html new file mode 100644 index 000000000..97ac2a7d0 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutDesignDocumentParams.html @@ -0,0 +1,23 @@ +PutDesignDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putDesignDocument operation.

+
interface PutDesignDocumentParams {
    batch?: string;
    db: string;
    ddoc: string;
    designDocument: CloudantV1.DesignDocument;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID +excluding the _design/ prefix.

+
designDocument: CloudantV1.DesignDocument

HTTP request body for DesignDocument operations.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

+

Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.PutDocumentParams.html new file mode 100644 index 000000000..5e844b2b2 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutDocumentParams.html @@ -0,0 +1,24 @@ +PutDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putDocument operation.

+
interface PutDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

+

Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutLocalDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.PutLocalDocumentParams.html new file mode 100644 index 000000000..344e283fe --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutLocalDocumentParams.html @@ -0,0 +1,14 @@ +PutLocalDocumentParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putLocalDocument operation.

+
interface PutLocalDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document;
    headers?: OutgoingHttpHeaders;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
document: Buffer<ArrayBufferLike> | ReadableStream | CloudantV1.Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutReplicationDocumentParams.html b/docs/0.12.1/interfaces/CloudantV1.PutReplicationDocumentParams.html new file mode 100644 index 000000000..9851b1cb4 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutReplicationDocumentParams.html @@ -0,0 +1,20 @@ +PutReplicationDocumentParams | @ibm-cloud/cloudant - v0.12.1

Interface PutReplicationDocumentParams

Parameters for the putReplicationDocument operation.

+
interface PutReplicationDocumentParams {
    batch?: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    replicationDocument: CloudantV1.ReplicationDocument;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted +response code immediately.

+
docId: string

Path parameter to specify the ID of the stored replication configuration in the _replicator database.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a +well-formed _rev must be included in the document. False is used by the replicator to insert documents into the +target database even if that leads to the creation of conflicts.

+

Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it +is very easy to accidentally end up with a large number of conflicts.

+
replicationDocument: CloudantV1.ReplicationDocument

HTTP request body for replication operations.

+
rev?: string

Query parameter to specify a document revision.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.PutSecurityParams.html b/docs/0.12.1/interfaces/CloudantV1.PutSecurityParams.html new file mode 100644 index 000000000..a7ecf8d52 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.PutSecurityParams.html @@ -0,0 +1,13 @@ +PutSecurityParams | @ibm-cloud/cloudant - v0.12.1

Parameters for the putSecurity operation.

+
interface PutSecurityParams {
    admins?: CloudantV1.SecurityObject;
    cloudant?: JsonObject;
    couchdbAuthOnly?: boolean;
    db: string;
    headers?: OutgoingHttpHeaders;
    members?: CloudantV1.SecurityObject;
}

Properties

Schema for names and roles to map to a database permission.

+
cloudant?: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdbAuthOnly?: boolean

Manage permissions using the _users database only.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Schema for names and roles to map to a database permission.

+
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationCreateTargetParameters.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationCreateTargetParameters.Transport.html new file mode 100644 index 000000000..c3b6757ea --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationCreateTargetParameters.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    n?: number;
    partitioned?: boolean;
    q?: number;
}

Properties

Properties

n?: number
partitioned?: boolean
q?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabase.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabase.Transport.html new file mode 100644 index 000000000..be3a2964e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabase.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    auth?: CloudantV1.ReplicationDatabaseAuth.Transport;
    headers?: JsonObject;
    url: string;
}

Properties

Properties

headers?: JsonObject
url: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuth.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuth.Transport.html new file mode 100644 index 000000000..d22147e74 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuth.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthBasic.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthBasic.Transport.html new file mode 100644 index 000000000..c955363d3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthBasic.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    password: string;
    username: string;
}

Properties

Properties

password: string
username: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthIam.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthIam.Transport.html new file mode 100644 index 000000000..d5f0960bc --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationDatabaseAuthIam.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    api_key: string;
}

Properties

Properties

api_key: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ReplicationDocument.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ReplicationDocument.Transport.html new file mode 100644 index 000000000..6cf008e75 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ReplicationDocument.Transport.html @@ -0,0 +1,36 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    _attachments?: { [key: string]: CloudantV1.Attachment.Transport };
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: CloudantV1.Revisions.Transport;
    _revs_info?: CloudantV1.DocumentRevisionStatus[];
    cancel?: boolean;
    checkpoint_interval?: number;
    connection_timeout?: number;
    continuous?: boolean;
    create_target?: boolean;
    create_target_params?: CloudantV1.ReplicationCreateTargetParameters.Transport;
    doc_ids?: string[];
    filter?: string;
    http_connections?: number;
    owner?: string;
    query_params?: JsonObject;
    retries_per_request?: number;
    selector?: JsonObject;
    since_seq?: string;
    socket_options?: string;
    source: CloudantV1.ReplicationDatabase.Transport;
    source_proxy?: string;
    target: CloudantV1.ReplicationDatabase.Transport;
    target_proxy?: string;
    use_bulk_get?: boolean;
    use_checkpoints?: boolean;
    user_ctx?: CloudantV1.UserContext.Transport;
    winning_revs_only?: boolean;
    worker_batch_size?: number;
    worker_processes?: number;
    [propName: string]: any;
}

Indexable

  • [propName: string]: any

    ReplicationDocument.ReplicationDocument.Transport accepts additional properties of type any.

    +

Properties

_attachments?: { [key: string]: CloudantV1.Attachment.Transport }
_conflicts?: string[]
_deleted?: boolean
_deleted_conflicts?: string[]
_id?: string
_local_seq?: string
_rev?: string
cancel?: boolean
checkpoint_interval?: number
connection_timeout?: number
continuous?: boolean
create_target?: boolean
doc_ids?: string[]
filter?: string
http_connections?: number
owner?: string
query_params?: JsonObject
retries_per_request?: number
selector?: JsonObject
since_seq?: string
socket_options?: string
source_proxy?: string
target_proxy?: string
use_bulk_get?: boolean
use_checkpoints?: boolean
winning_revs_only?: boolean
worker_batch_size?: number
worker_processes?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.Response.html b/docs/0.12.1/interfaces/CloudantV1.Response.html new file mode 100644 index 000000000..c6fed10da --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Response.html @@ -0,0 +1,6 @@ +Response | @ibm-cloud/cloudant - v0.12.1

An operation response.

+
interface Response<T = any> {
    headers: IncomingHttpHeaders;
    result: T;
    status: number;
    statusText: string;
}

Type Parameters

  • T = any

Properties

headers: IncomingHttpHeaders
result: T
status: number
statusText: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.Revisions.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Revisions.Transport.html new file mode 100644 index 000000000..ff63c9d77 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Revisions.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    ids: string[];
    start: number;
}

Properties

Properties

ids: string[]
start: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.RevsDiff.Transport.html b/docs/0.12.1/interfaces/CloudantV1.RevsDiff.Transport.html new file mode 100644 index 000000000..244a5edb8 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.RevsDiff.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    missing?: string[];
    possible_ancestors?: string[];
}

Properties

missing?: string[]
possible_ancestors?: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerDocsResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerDocsResult.Transport.html new file mode 100644 index 000000000..843acb904 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerDocsResult.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    docs: CloudantV1.SchedulerDocument[];
    total_rows: number;
}

Properties

Properties

total_rows: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerDocument.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerDocument.Transport.html new file mode 100644 index 000000000..4980bbff6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerDocument.Transport.html @@ -0,0 +1,14 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    database: string;
    doc_id: string;
    error_count: number;
    id: string;
    info: CloudantV1.SchedulerInfo.Transport;
    last_updated: string;
    node?: string;
    source?: string;
    source_proxy?: string;
    start_time: string;
    state: string;
    target?: string;
    target_proxy?: string;
}

Properties

database: string
doc_id: string
error_count: number
id: string
last_updated: string
node?: string
source?: string
source_proxy?: string
start_time: string
state: string
target?: string
target_proxy?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerInfo.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerInfo.Transport.html new file mode 100644 index 000000000..63c528d0f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerInfo.Transport.html @@ -0,0 +1,11 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    changes_pending?: number;
    checkpointed_source_seq?: string;
    doc_write_failures?: number;
    docs_read?: number;
    docs_written?: number;
    error?: string;
    missing_revisions_found?: number;
    revisions_checked?: number;
    source_seq?: string;
    through_seq?: string;
}

Properties

changes_pending?: number
checkpointed_source_seq?: string
doc_write_failures?: number
docs_read?: number
docs_written?: number
error?: string
missing_revisions_found?: number
revisions_checked?: number
source_seq?: string
through_seq?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerJob.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerJob.Transport.html new file mode 100644 index 000000000..bc6c8f9a4 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerJob.Transport.html @@ -0,0 +1,12 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    database: string;
    doc_id: string;
    history: CloudantV1.SchedulerJobEvent[];
    id: string;
    info: CloudantV1.SchedulerInfo.Transport;
    node: string;
    pid: string;
    source: string;
    start_time: string;
    target: string;
    user: string;
}

Properties

database: string
doc_id: string
id: string
node: string
pid: string
source: string
start_time: string
target: string
user: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerJobEvent.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerJobEvent.Transport.html new file mode 100644 index 000000000..b40552179 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerJobEvent.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    reason?: string;
    timestamp: string;
    type: string;
}

Properties

Properties

reason?: string
timestamp: string
type: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SchedulerJobsResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SchedulerJobsResult.Transport.html new file mode 100644 index 000000000..a2abd002c --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SchedulerJobsResult.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    jobs: CloudantV1.SchedulerJob[];
    total_rows: number;
}

Properties

Properties

total_rows: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchAnalyzeResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchAnalyzeResult.Transport.html new file mode 100644 index 000000000..86ca8d90d --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchAnalyzeResult.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    tokens: string[];
}

Properties

Properties

tokens: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchDiskSizeInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchDiskSizeInformation.Transport.html new file mode 100644 index 000000000..a6a43cfee --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchDiskSizeInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
    search_index: CloudantV1.SearchIndexDiskSize.Transport;
}

Properties

Properties

name: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchIndexDefinition.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchIndexDefinition.Transport.html new file mode 100644 index 000000000..5d897d8c9 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchIndexDefinition.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    analyzer?: CloudantV1.AnalyzerConfiguration.Transport;
    index: string;
}

Properties

Properties

index: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchIndexDiskSize.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchIndexDiskSize.Transport.html new file mode 100644 index 000000000..f62658a0d --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchIndexDiskSize.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    disk_size?: number;
}

Properties

Properties

disk_size?: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchIndexInfo.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchIndexInfo.Transport.html new file mode 100644 index 000000000..4a7f8e2f7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchIndexInfo.Transport.html @@ -0,0 +1,7 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    committed_seq: number;
    disk_size: number;
    doc_count: number;
    doc_del_count: number;
    pending_seq: number;
    signature: string;
}

Properties

committed_seq: number
disk_size: number
doc_count: number
doc_del_count: number
pending_seq: number
signature: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchInfoResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchInfoResult.Transport.html new file mode 100644 index 000000000..c3e676303 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchInfoResult.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
    search_index: CloudantV1.SearchIndexInfo.Transport;
}

Properties

Properties

name: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchResult.Transport.html new file mode 100644 index 000000000..5e780708e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchResult.Transport.html @@ -0,0 +1,8 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    bookmark?: string;
    by?: string;
    counts?: { [key: string]: JsonObject };
    groups?: CloudantV1.SearchResultProperties[];
    ranges?: { [key: string]: JsonObject };
    rows: CloudantV1.SearchResultRow[];
    total_rows: number;
}

Properties

bookmark?: string
by?: string
counts?: { [key: string]: JsonObject }
ranges?: { [key: string]: JsonObject }
total_rows: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchResultProperties.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchResultProperties.Transport.html new file mode 100644 index 000000000..d06ce2b42 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchResultProperties.Transport.html @@ -0,0 +1,7 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    bookmark?: string;
    by?: string;
    counts?: { [key: string]: JsonObject };
    ranges?: { [key: string]: JsonObject };
    rows: CloudantV1.SearchResultRow[];
    total_rows: number;
}

Properties

bookmark?: string
by?: string
counts?: { [key: string]: JsonObject }
ranges?: { [key: string]: JsonObject }
total_rows: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.SearchResultRow.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SearchResultRow.Transport.html new file mode 100644 index 000000000..aef46873e --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SearchResultRow.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    doc?: CloudantV1.Document.Transport;
    fields: JsonObject;
    highlights?: JsonObject;
    id: string;
}

Properties

Properties

fields: JsonObject
highlights?: JsonObject
id: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.Security.Transport.html b/docs/0.12.1/interfaces/CloudantV1.Security.Transport.html new file mode 100644 index 000000000..65a5af4a4 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.Security.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    admins?: CloudantV1.SecurityObject.Transport;
    cloudant?: JsonObject;
    couchdb_auth_only?: boolean;
    members?: CloudantV1.SecurityObject.Transport;
}

Properties

cloudant?: JsonObject
couchdb_auth_only?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.SecurityObject.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SecurityObject.Transport.html new file mode 100644 index 000000000..13d5eeb63 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SecurityObject.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    names?: string[];
    roles?: string[];
}

Properties

Properties

names?: string[]
roles?: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.SelectorHint.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SelectorHint.Transport.html new file mode 100644 index 000000000..1d207b885 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SelectorHint.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    indexable_fields: string[];
    type: string;
    unindexable_fields: string[];
}

Properties

indexable_fields: string[]
type: string
unindexable_fields: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.ServerInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ServerInformation.Transport.html new file mode 100644 index 000000000..47b670f59 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ServerInformation.Transport.html @@ -0,0 +1,6 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    couchdb: string;
    features: string[];
    features_flags: string[];
    vendor: CloudantV1.ServerVendor.Transport;
    version: string;
}

Properties

couchdb: string
features: string[]
features_flags: string[]
version: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ServerVendor.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ServerVendor.Transport.html new file mode 100644 index 000000000..aabc2109f --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ServerVendor.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    name: string;
    variant: string;
    version: string;
    [propName: string]: any;
}

Indexable

  • [propName: string]: any

    ServerVendor.ServerVendor.Transport accepts additional properties of type string.

    +

Properties

Properties

name: string
variant: string
version: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.SessionAuthentication.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SessionAuthentication.Transport.html new file mode 100644 index 000000000..47861f2b7 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SessionAuthentication.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    authenticated?: string;
    authentication_db?: string;
    authentication_handlers: string[];
}

Properties

authenticated?: string
authentication_db?: string
authentication_handlers: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.SessionInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.SessionInformation.Transport.html new file mode 100644 index 000000000..11b1c8e86 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.SessionInformation.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    info: CloudantV1.SessionAuthentication.Transport;
    ok: boolean;
    userCtx: CloudantV1.UserContext.Transport;
}

Properties

Properties

ok: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.ShardsInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ShardsInformation.Transport.html new file mode 100644 index 000000000..ed914ca44 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ShardsInformation.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    shards: JsonObject;
}

Properties

Properties

shards: JsonObject
diff --git a/docs/0.12.1/interfaces/CloudantV1.ThroughputInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ThroughputInformation.Transport.html new file mode 100644 index 000000000..c49aa73c8 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ThroughputInformation.Transport.html @@ -0,0 +1,5 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    blocks?: number;
    query: number;
    read: number;
    write: number;
}

Properties

Properties

blocks?: number
query: number
read: number
write: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.UpInformation.Transport.html b/docs/0.12.1/interfaces/CloudantV1.UpInformation.Transport.html new file mode 100644 index 000000000..21e717eca --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.UpInformation.Transport.html @@ -0,0 +1,3 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    seeds?: JsonObject;
    status: string;
}

Properties

Properties

seeds?: JsonObject
status: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.UpdatesPending.Transport.html b/docs/0.12.1/interfaces/CloudantV1.UpdatesPending.Transport.html new file mode 100644 index 000000000..c1c556f46 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.UpdatesPending.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    minimum: number;
    preferred: number;
    total: number;
}

Properties

Properties

minimum: number
preferred: number
total: number
diff --git a/docs/0.12.1/interfaces/CloudantV1.UserContext.Transport.html b/docs/0.12.1/interfaces/CloudantV1.UserContext.Transport.html new file mode 100644 index 000000000..81518f244 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.UserContext.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    db?: string;
    name: string;
    roles: string[];
}

Properties

Properties

db?: string
name: string
roles: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.UuidsResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.UuidsResult.Transport.html new file mode 100644 index 000000000..9768d8201 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.UuidsResult.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    uuids: string[];
}

Properties

Properties

uuids: string[]
diff --git a/docs/0.12.1/interfaces/CloudantV1.ViewQueriesResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ViewQueriesResult.Transport.html new file mode 100644 index 000000000..219eaf454 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ViewQueriesResult.Transport.html @@ -0,0 +1,2 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    results: CloudantV1.ViewResult[];
}

Properties

Properties

diff --git a/docs/0.12.1/interfaces/CloudantV1.ViewQuery.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ViewQuery.Transport.html new file mode 100644 index 000000000..f4c2c42e6 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ViewQuery.Transport.html @@ -0,0 +1,21 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    att_encoding_info?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    descending?: boolean;
    end_key?: any;
    end_key_doc_id?: string;
    group?: boolean;
    group_level?: number;
    include_docs?: boolean;
    inclusive_end?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    start_key?: any;
    start_key_doc_id?: string;
    update?: string;
    update_seq?: boolean;
}

Properties

att_encoding_info?: boolean
attachments?: boolean
conflicts?: boolean
descending?: boolean
end_key?: any
end_key_doc_id?: string
group?: boolean
group_level?: number
include_docs?: boolean
inclusive_end?: boolean
key?: any
keys?: any[]
limit?: number
reduce?: boolean
skip?: number
stable?: boolean
start_key?: any
start_key_doc_id?: string
update?: string
update_seq?: boolean
diff --git a/docs/0.12.1/interfaces/CloudantV1.ViewResult.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ViewResult.Transport.html new file mode 100644 index 000000000..2520f9fb3 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ViewResult.Transport.html @@ -0,0 +1,4 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    rows: CloudantV1.ViewResultRow[];
    total_rows?: number;
    update_seq?: string;
}

Properties

total_rows?: number
update_seq?: string
diff --git a/docs/0.12.1/interfaces/CloudantV1.ViewResultRow.Transport.html b/docs/0.12.1/interfaces/CloudantV1.ViewResultRow.Transport.html new file mode 100644 index 000000000..8c8e9ea35 --- /dev/null +++ b/docs/0.12.1/interfaces/CloudantV1.ViewResultRow.Transport.html @@ -0,0 +1,9 @@ +Transport | @ibm-cloud/cloudant - v0.12.1
interface Transport {
    caused_by?: string;
    doc?: CloudantV1.Document.Transport;
    error?: string;
    id?: string;
    key: any;
    reason?: string;
    ref?: number;
    value: any;
}

Properties

caused_by?: string
error?: string
id?: string
key: any
reason?: string
ref?: number
value: any
diff --git a/docs/0.12.1/media/KNOWN_ISSUES.md b/docs/0.12.1/media/KNOWN_ISSUES.md new file mode 100644 index 000000000..0744cb028 --- /dev/null +++ b/docs/0.12.1/media/KNOWN_ISSUES.md @@ -0,0 +1,113 @@ +# Limitations, Restrictions, and Known Issues + +## All Cloudant SDKs + +### Path elements containing the `+` character + +Path elements containing the `+` character in the SDKs are not interoperable with: +* Cloudant +* Apache CouchDB versions older than 3.2.0 +* Apache CouchDB versions 3.2.0 or newer with the setting `decode_plus_to_space = true` + +This is because standard URL encoding libraries following the [RFC3986 URI specification](https://tools.ietf.org/html/rfc3986#section-3.3) do not encode the `+` character in path elements. +* It is possible to workaround for document names with a `+` in the ID (e.g. `docidwith+char`) by using: + * For reading: use the `post` all docs operation and the `key` or `keys` parameter with a value of the document ID including the `+`. + * For writing: use the `post` document operation or `post` bulk docs operation with the value of the document ID including the `+`. +* There is no pre-encoding workaround because the result is a double encoding e.g. using `%2b` in the path element ends up being double encoded as `%252b`. + +### Views + +#### Objects as keys + +Using JSON objects as keys (e.g. `start_key`, `end_key`, `key`, `keys`) +can cause inconsistent results because the ordering of the members of the JSON +object after serialization is not guaranteed. + +### Documents + +#### Attachments + +The `atts_since` parameter is not supported when retrieving a document. +The workaround is to call `POST /{db}/_bulk_get` using the `atts_since` field under the `docs` request body. See the [alternative example request for `atts_since` using the `/_bulk_get` endpoint](https://cloud.ibm.com/apidocs/cloudant#postbulkget) in our API Docs. +Example JSON request body: +```json +{ + "docs": [{"id": "order00058", "atts_since": "1-99b02e08da151943c2dcb40090160bb8"}] +} +``` + +#### Open revisions + +The `open_revs` parameter is not supported when retrieving a document. +If you want to retrieve documents with all leaf revisions (`open_revs=all`), the workaround is to call `POST /{db}/_bulk_get` using the `id` field within the `docs` array request body. +See the [alternative example request for `open_revs=all` using the `/_bulk_get` endpoint](https://cloud.ibm.com/apidocs/cloudant#postbulkget) in our API Docs. +Example JSON request body: +```json +{ + "docs": [{"id": "order00067"}] +} +``` + +If you want to retrieve documents of specified leaf revisions (e.g. `open_revs=["3-917fa2381192822767f010b95b45325b", "4-a5be949eeb7296747cc271766e9a498b"]`), the workaround is to call `POST /{db}/_bulk_get` using the same `id` value for each unique `rev` value within of the `docs` array request body. +See the [default example request using the `/_bulk_get` endpoint](https://cloud.ibm.com/apidocs/cloudant#postbulkget) in our API Docs. +Example JSON request body: +```json +{ + "docs": [ + { + "id": "order00067", + "rev": "3-917fa2381192822767f010b95b45325b" + }, + { + "id": "order00067", + "rev": "4-a5be949eeb7296747cc271766e9a498b" + } + ] +} +``` + +### Compression + +* Manually setting an `Accept-Encoding` header on requests will disable the transparent gzip decompression of response bodies from the server. +* Manually setting a `Content-Encoding` header on requests will disable the transparent gzip compression of request bodies to the server. + +### Changes feed + +#### Filter functions + +The SDK does not support passing user-defined query or body parameters in `_changes` requests for dynamic filter functions in design documents. +The workaround and recommended option is to use a `selector` type filter. +For example, if you are using a `_changes` request like `/{db}/_changes?filter=myDdoc/byName&name=Jane` with a filter function like: +```javascript +function(doc, req) { + if (doc.name !== req.query.name) { + return false; + } + return true; +} +``` +It can be replaced with a request using a selector filter: +```js +const service = CloudantV1.newInstance({}); + +service.postChanges({ + db: 'example', + filter: '_selector', + selector: {"name": "Jane"} +}).then(response => { ... }); +``` + + +## Cloudant SDK for Node.js + +### Disabling request body compression + +Some issues with older server versions can be worked around by disabling +compression of request bodies. This is an example of how to do that. + +```js +import { CloudantV1 } from '@ibm-cloud/cloudant'; +const client = CloudantV1.newInstance({ serviceName: 'YOUR_SERVICE_NAME' }); +client.setEnableGzipCompression(false); +... +``` diff --git a/docs/0.12.1/modules.html b/docs/0.12.1/modules.html new file mode 100644 index 000000000..a4ab24b8c --- /dev/null +++ b/docs/0.12.1/modules.html @@ -0,0 +1 @@ +@ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ActiveTask.Constants.html b/docs/0.12.1/modules/CloudantV1.ActiveTask.Constants.html new file mode 100644 index 000000000..3c3372aa8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ActiveTask.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ActiveTask.html b/docs/0.12.1/modules/CloudantV1.ActiveTask.html new file mode 100644 index 000000000..fef392aa4 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ActiveTask.html @@ -0,0 +1 @@ +ActiveTask | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.Constants.html b/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.Constants.html new file mode 100644 index 000000000..c5537fe6a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.html b/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.html new file mode 100644 index 000000000..2347e0aaf --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ActivityTrackerEvents.html @@ -0,0 +1 @@ +ActivityTrackerEvents | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.AllDocsQueriesResult.html b/docs/0.12.1/modules/CloudantV1.AllDocsQueriesResult.html new file mode 100644 index 000000000..2f2a9306d --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.AllDocsQueriesResult.html @@ -0,0 +1 @@ +AllDocsQueriesResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.AllDocsQuery.html b/docs/0.12.1/modules/CloudantV1.AllDocsQuery.html new file mode 100644 index 000000000..3f291b092 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.AllDocsQuery.html @@ -0,0 +1 @@ +AllDocsQuery | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.AllDocsResult.html b/docs/0.12.1/modules/CloudantV1.AllDocsResult.html new file mode 100644 index 000000000..47b90bba7 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.AllDocsResult.html @@ -0,0 +1 @@ +AllDocsResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Analyzer.Constants.html b/docs/0.12.1/modules/CloudantV1.Analyzer.Constants.html new file mode 100644 index 000000000..77cd1c3de --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Analyzer.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.Analyzer.html b/docs/0.12.1/modules/CloudantV1.Analyzer.html new file mode 100644 index 000000000..397d0c7a2 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Analyzer.html @@ -0,0 +1 @@ +Analyzer | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.Constants.html b/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.Constants.html new file mode 100644 index 000000000..1825e3fcc --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.html b/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.html new file mode 100644 index 000000000..2b83cf64b --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.AnalyzerConfiguration.html @@ -0,0 +1 @@ +AnalyzerConfiguration | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ApiKeysResult.html b/docs/0.12.1/modules/CloudantV1.ApiKeysResult.html new file mode 100644 index 000000000..b50ada264 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ApiKeysResult.html @@ -0,0 +1 @@ +ApiKeysResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Attachment.html b/docs/0.12.1/modules/CloudantV1.Attachment.html new file mode 100644 index 000000000..96bf1fa38 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Attachment.html @@ -0,0 +1 @@ +Attachment | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.BulkDocs.html b/docs/0.12.1/modules/CloudantV1.BulkDocs.html new file mode 100644 index 000000000..3485a5cf6 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.BulkDocs.html @@ -0,0 +1 @@ +BulkDocs | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.BulkGetQueryDocument.html b/docs/0.12.1/modules/CloudantV1.BulkGetQueryDocument.html new file mode 100644 index 000000000..d3c07e119 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.BulkGetQueryDocument.html @@ -0,0 +1 @@ +BulkGetQueryDocument | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.BulkGetResult.html b/docs/0.12.1/modules/CloudantV1.BulkGetResult.html new file mode 100644 index 000000000..91f30d490 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.BulkGetResult.html @@ -0,0 +1 @@ +BulkGetResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.BulkGetResultDocument.html b/docs/0.12.1/modules/CloudantV1.BulkGetResultDocument.html new file mode 100644 index 000000000..1d2614827 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.BulkGetResultDocument.html @@ -0,0 +1 @@ +BulkGetResultDocument | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.BulkGetResultItem.html b/docs/0.12.1/modules/CloudantV1.BulkGetResultItem.html new file mode 100644 index 000000000..f34780b36 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.BulkGetResultItem.html @@ -0,0 +1 @@ +BulkGetResultItem | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformation.html b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformation.html new file mode 100644 index 000000000..34fe81b97 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformation.html @@ -0,0 +1 @@ +CapacityThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Namespace CapacityThroughputInformation

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationCurrent.html b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationCurrent.html new file mode 100644 index 000000000..bd5c549f3 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationCurrent.html @@ -0,0 +1 @@ +CapacityThroughputInformationCurrent | @ibm-cloud/cloudant - v0.12.1

Namespace CapacityThroughputInformationCurrent

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationTarget.html b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationTarget.html new file mode 100644 index 000000000..0d01cd3b6 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CapacityThroughputInformationTarget.html @@ -0,0 +1 @@ +CapacityThroughputInformationTarget | @ibm-cloud/cloudant - v0.12.1

Namespace CapacityThroughputInformationTarget

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Change.html b/docs/0.12.1/modules/CloudantV1.Change.html new file mode 100644 index 000000000..c1350ad62 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Change.html @@ -0,0 +1 @@ +Change | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ChangesResult.html b/docs/0.12.1/modules/CloudantV1.ChangesResult.html new file mode 100644 index 000000000..0ffc2fe87 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ChangesResult.html @@ -0,0 +1 @@ +ChangesResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ChangesResultItem.html b/docs/0.12.1/modules/CloudantV1.ChangesResultItem.html new file mode 100644 index 000000000..cb7dac904 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ChangesResultItem.html @@ -0,0 +1 @@ +ChangesResultItem | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ContentInformationSizes.html b/docs/0.12.1/modules/CloudantV1.ContentInformationSizes.html new file mode 100644 index 000000000..7ef85c434 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ContentInformationSizes.html @@ -0,0 +1 @@ +ContentInformationSizes | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CorsInformation.html b/docs/0.12.1/modules/CloudantV1.CorsInformation.html new file mode 100644 index 000000000..5f3c9fdae --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CorsInformation.html @@ -0,0 +1 @@ +CorsInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformation.html b/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformation.html new file mode 100644 index 000000000..df4772620 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformation.html @@ -0,0 +1 @@ +CurrentThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Namespace CurrentThroughputInformation

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformationThroughput.html b/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformationThroughput.html new file mode 100644 index 000000000..9aec19b0a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.CurrentThroughputInformationThroughput.html @@ -0,0 +1 @@ +CurrentThroughputInformationThroughput | @ibm-cloud/cloudant - v0.12.1

Namespace CurrentThroughputInformationThroughput

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DatabaseInformation.html b/docs/0.12.1/modules/CloudantV1.DatabaseInformation.html new file mode 100644 index 000000000..44ee29e5d --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DatabaseInformation.html @@ -0,0 +1 @@ +DatabaseInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DatabaseInformationCluster.html b/docs/0.12.1/modules/CloudantV1.DatabaseInformationCluster.html new file mode 100644 index 000000000..07c67b1b8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DatabaseInformationCluster.html @@ -0,0 +1 @@ +DatabaseInformationCluster | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DatabaseInformationProps.html b/docs/0.12.1/modules/CloudantV1.DatabaseInformationProps.html new file mode 100644 index 000000000..f982d0987 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DatabaseInformationProps.html @@ -0,0 +1 @@ +DatabaseInformationProps | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DbEvent.Constants.html b/docs/0.12.1/modules/CloudantV1.DbEvent.Constants.html new file mode 100644 index 000000000..df87dfb78 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DbEvent.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.DbEvent.html b/docs/0.12.1/modules/CloudantV1.DbEvent.html new file mode 100644 index 000000000..7b2a4379b --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DbEvent.html @@ -0,0 +1 @@ +DbEvent | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DbUpdates.html b/docs/0.12.1/modules/CloudantV1.DbUpdates.html new file mode 100644 index 000000000..3f153c751 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DbUpdates.html @@ -0,0 +1 @@ +DbUpdates | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.DbsInfoResult.html b/docs/0.12.1/modules/CloudantV1.DbsInfoResult.html new file mode 100644 index 000000000..cc177c51f --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DbsInfoResult.html @@ -0,0 +1 @@ +DbsInfoResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteAttachmentConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteAttachmentConstants.html new file mode 100644 index 000000000..852ada639 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteAttachmentConstants.html @@ -0,0 +1,2 @@ +DeleteAttachmentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the deleteAttachment operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteDesignDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteDesignDocumentConstants.html new file mode 100644 index 000000000..ee756006d --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteDesignDocumentConstants.html @@ -0,0 +1,2 @@ +DeleteDesignDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Namespace DeleteDesignDocumentConstants

Constants for the deleteDesignDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteDocumentConstants.html new file mode 100644 index 000000000..d1be59945 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteDocumentConstants.html @@ -0,0 +1,2 @@ +DeleteDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the deleteDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteIndexConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteIndexConstants.html new file mode 100644 index 000000000..2ec3d7123 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteIndexConstants.html @@ -0,0 +1,2 @@ +DeleteIndexConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the deleteIndex operation.

+

Enumerations

Type
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteLocalDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteLocalDocumentConstants.html new file mode 100644 index 000000000..2c2f4c6eb --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteLocalDocumentConstants.html @@ -0,0 +1,2 @@ +DeleteLocalDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Namespace DeleteLocalDocumentConstants

Constants for the deleteLocalDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.DeleteReplicationDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.DeleteReplicationDocumentConstants.html new file mode 100644 index 000000000..943bfadea --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DeleteReplicationDocumentConstants.html @@ -0,0 +1,2 @@ +DeleteReplicationDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Namespace DeleteReplicationDocumentConstants

Constants for the deleteReplicationDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.DesignDocument.html b/docs/0.12.1/modules/CloudantV1.DesignDocument.html new file mode 100644 index 000000000..c49662a33 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DesignDocument.html @@ -0,0 +1 @@ +DesignDocument | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DesignDocumentInformation.html b/docs/0.12.1/modules/CloudantV1.DesignDocumentInformation.html new file mode 100644 index 000000000..418b6b44b --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DesignDocumentInformation.html @@ -0,0 +1 @@ +DesignDocumentInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DesignDocumentOptions.html b/docs/0.12.1/modules/CloudantV1.DesignDocumentOptions.html new file mode 100644 index 000000000..b33fef460 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DesignDocumentOptions.html @@ -0,0 +1 @@ +DesignDocumentOptions | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DesignDocumentViewIndex.html b/docs/0.12.1/modules/CloudantV1.DesignDocumentViewIndex.html new file mode 100644 index 000000000..98ba929d5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DesignDocumentViewIndex.html @@ -0,0 +1 @@ +DesignDocumentViewIndex | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DesignDocumentViewsMapReduce.html b/docs/0.12.1/modules/CloudantV1.DesignDocumentViewsMapReduce.html new file mode 100644 index 000000000..6459e34b3 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DesignDocumentViewsMapReduce.html @@ -0,0 +1 @@ +DesignDocumentViewsMapReduce | @ibm-cloud/cloudant - v0.12.1

Namespace DesignDocumentViewsMapReduce

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DocsResultRow.html b/docs/0.12.1/modules/CloudantV1.DocsResultRow.html new file mode 100644 index 000000000..10ea5b8c6 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocsResultRow.html @@ -0,0 +1 @@ +DocsResultRow | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DocsResultRowValue.html b/docs/0.12.1/modules/CloudantV1.DocsResultRowValue.html new file mode 100644 index 000000000..e0a94472a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocsResultRowValue.html @@ -0,0 +1 @@ +DocsResultRowValue | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Document.html b/docs/0.12.1/modules/CloudantV1.Document.html new file mode 100644 index 000000000..80eaa7c94 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Document.html @@ -0,0 +1 @@ +Document | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.DocumentResult.html b/docs/0.12.1/modules/CloudantV1.DocumentResult.html new file mode 100644 index 000000000..2aebfdc61 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocumentResult.html @@ -0,0 +1 @@ +DocumentResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.Constants.html b/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.Constants.html new file mode 100644 index 000000000..36c9c9de5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.html b/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.html new file mode 100644 index 000000000..70aa20182 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocumentRevisionStatus.html @@ -0,0 +1 @@ +DocumentRevisionStatus | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.DocumentShardInfo.html b/docs/0.12.1/modules/CloudantV1.DocumentShardInfo.html new file mode 100644 index 000000000..e707f104f --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.DocumentShardInfo.html @@ -0,0 +1 @@ +DocumentShardInfo | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ExecutionStats.html b/docs/0.12.1/modules/CloudantV1.ExecutionStats.html new file mode 100644 index 000000000..87ea684ff --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ExecutionStats.html @@ -0,0 +1 @@ +ExecutionStats | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ExplainResult.html b/docs/0.12.1/modules/CloudantV1.ExplainResult.html new file mode 100644 index 000000000..d29619b45 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ExplainResult.html @@ -0,0 +1 @@ +ExplainResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.Constants.html b/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.Constants.html new file mode 100644 index 000000000..5277dfbca --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.html b/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.html new file mode 100644 index 000000000..523709af8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ExplainResultMrArgs.html @@ -0,0 +1 @@ +ExplainResultMrArgs | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ExplainResultOpts.html b/docs/0.12.1/modules/CloudantV1.ExplainResultOpts.html new file mode 100644 index 000000000..febec3da5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ExplainResultOpts.html @@ -0,0 +1 @@ +ExplainResultOpts | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.FindResult.html b/docs/0.12.1/modules/CloudantV1.FindResult.html new file mode 100644 index 000000000..0b5b3ea67 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.FindResult.html @@ -0,0 +1 @@ +FindResult | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.GetDbUpdatesConstants.html b/docs/0.12.1/modules/CloudantV1.GetDbUpdatesConstants.html new file mode 100644 index 000000000..6f53aca15 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.GetDbUpdatesConstants.html @@ -0,0 +1,2 @@ +GetDbUpdatesConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the getDbUpdates operation.

+

Enumerations

Feed
diff --git a/docs/0.12.1/modules/CloudantV1.GetLocalDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.GetLocalDocumentConstants.html new file mode 100644 index 000000000..5424e6500 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.GetLocalDocumentConstants.html @@ -0,0 +1,2 @@ +GetLocalDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the getLocalDocument operation.

+

Enumerations

Accept
diff --git a/docs/0.12.1/modules/CloudantV1.GetSchedulerDocsConstants.html b/docs/0.12.1/modules/CloudantV1.GetSchedulerDocsConstants.html new file mode 100644 index 000000000..bfd9a9709 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.GetSchedulerDocsConstants.html @@ -0,0 +1,2 @@ +GetSchedulerDocsConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the getSchedulerDocs operation.

+

Enumerations

States
diff --git a/docs/0.12.1/modules/CloudantV1.IndexAnalysis.html b/docs/0.12.1/modules/CloudantV1.IndexAnalysis.html new file mode 100644 index 000000000..5e3af4d1c --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexAnalysis.html @@ -0,0 +1 @@ +IndexAnalysis | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.Constants.html b/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.Constants.html new file mode 100644 index 000000000..64e0e2e1a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.html b/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.html new file mode 100644 index 000000000..4627ad394 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexAnalysisExclusionReason.html @@ -0,0 +1 @@ +IndexAnalysisExclusionReason | @ibm-cloud/cloudant - v0.12.1

Namespace IndexAnalysisExclusionReason

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexCandidate.html b/docs/0.12.1/modules/CloudantV1.IndexCandidate.html new file mode 100644 index 000000000..0b56301d3 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexCandidate.html @@ -0,0 +1 @@ +IndexCandidate | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexDefinition.html b/docs/0.12.1/modules/CloudantV1.IndexDefinition.html new file mode 100644 index 000000000..f19c490ca --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexDefinition.html @@ -0,0 +1 @@ +IndexDefinition | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexField.Constants.html b/docs/0.12.1/modules/CloudantV1.IndexField.Constants.html new file mode 100644 index 000000000..762c8e80d --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexField.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.IndexField.html b/docs/0.12.1/modules/CloudantV1.IndexField.html new file mode 100644 index 000000000..45fd71b36 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexField.html @@ -0,0 +1 @@ +IndexField | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexInformation.Constants.html b/docs/0.12.1/modules/CloudantV1.IndexInformation.Constants.html new file mode 100644 index 000000000..294411a2b --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexInformation.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.IndexInformation.html b/docs/0.12.1/modules/CloudantV1.IndexInformation.html new file mode 100644 index 000000000..71e372288 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexInformation.html @@ -0,0 +1 @@ +IndexInformation | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexResult.Constants.html b/docs/0.12.1/modules/CloudantV1.IndexResult.Constants.html new file mode 100644 index 000000000..ac786a2c1 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexResult.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.IndexResult.html b/docs/0.12.1/modules/CloudantV1.IndexResult.html new file mode 100644 index 000000000..45727924b --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexResult.html @@ -0,0 +1 @@ +IndexResult | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexTextOperatorDefaultField.html b/docs/0.12.1/modules/CloudantV1.IndexTextOperatorDefaultField.html new file mode 100644 index 000000000..3c3ad15ea --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexTextOperatorDefaultField.html @@ -0,0 +1 @@ +IndexTextOperatorDefaultField | @ibm-cloud/cloudant - v0.12.1

Namespace IndexTextOperatorDefaultField

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.IndexesInformation.html b/docs/0.12.1/modules/CloudantV1.IndexesInformation.html new file mode 100644 index 000000000..96c4817a9 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.IndexesInformation.html @@ -0,0 +1 @@ +IndexesInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.MembershipInformation.html b/docs/0.12.1/modules/CloudantV1.MembershipInformation.html new file mode 100644 index 000000000..c07230abd --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.MembershipInformation.html @@ -0,0 +1 @@ +MembershipInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Ok.html b/docs/0.12.1/modules/CloudantV1.Ok.html new file mode 100644 index 000000000..46a067d19 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Ok.html @@ -0,0 +1 @@ +Ok | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionInformation.html b/docs/0.12.1/modules/CloudantV1.PartitionInformation.html new file mode 100644 index 000000000..48db38d59 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionInformation.html @@ -0,0 +1 @@ +PartitionInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexes.html b/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexes.html new file mode 100644 index 000000000..953d446af --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexes.html @@ -0,0 +1 @@ +PartitionInformationIndexes | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexesIndexes.html b/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexesIndexes.html new file mode 100644 index 000000000..c16c2954c --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionInformationIndexesIndexes.html @@ -0,0 +1 @@ +PartitionInformationIndexesIndexes | @ibm-cloud/cloudant - v0.12.1

Namespace PartitionInformationIndexesIndexes

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionInformationSizes.html b/docs/0.12.1/modules/CloudantV1.PartitionInformationSizes.html new file mode 100644 index 000000000..e67dd76b0 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionInformationSizes.html @@ -0,0 +1 @@ +PartitionInformationSizes | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionedIndexesDetailedInformation.html b/docs/0.12.1/modules/CloudantV1.PartitionedIndexesDetailedInformation.html new file mode 100644 index 000000000..e4047bc68 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionedIndexesDetailedInformation.html @@ -0,0 +1 @@ +PartitionedIndexesDetailedInformation | @ibm-cloud/cloudant - v0.12.1

Namespace PartitionedIndexesDetailedInformation

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PartitionedIndexesInformation.html b/docs/0.12.1/modules/CloudantV1.PartitionedIndexesInformation.html new file mode 100644 index 000000000..e63268a21 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PartitionedIndexesInformation.html @@ -0,0 +1 @@ +PartitionedIndexesInformation | @ibm-cloud/cloudant - v0.12.1

Namespace PartitionedIndexesInformation

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.PostActivityTrackerEventsConstants.html b/docs/0.12.1/modules/CloudantV1.PostActivityTrackerEventsConstants.html new file mode 100644 index 000000000..542478072 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostActivityTrackerEventsConstants.html @@ -0,0 +1,2 @@ +PostActivityTrackerEventsConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostActivityTrackerEventsConstants

Constants for the postActivityTrackerEvents operation.

+

Enumerations

Types
diff --git a/docs/0.12.1/modules/CloudantV1.PostChangesAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostChangesAsStreamConstants.html new file mode 100644 index 000000000..8af007435 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostChangesAsStreamConstants.html @@ -0,0 +1,2 @@ +PostChangesAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostChangesAsStreamConstants

Constants for the postChangesAsStream operation.

+

Enumerations

Feed
Style
diff --git a/docs/0.12.1/modules/CloudantV1.PostChangesConstants.html b/docs/0.12.1/modules/CloudantV1.PostChangesConstants.html new file mode 100644 index 000000000..de4bd61ca --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostChangesConstants.html @@ -0,0 +1,2 @@ +PostChangesConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postChanges operation.

+

Enumerations

Feed
Style
diff --git a/docs/0.12.1/modules/CloudantV1.PostDesignDocsQueriesConstants.html b/docs/0.12.1/modules/CloudantV1.PostDesignDocsQueriesConstants.html new file mode 100644 index 000000000..1b35018eb --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostDesignDocsQueriesConstants.html @@ -0,0 +1,2 @@ +PostDesignDocsQueriesConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostDesignDocsQueriesConstants

Constants for the postDesignDocsQueries operation.

+

Enumerations

Accept
diff --git a/docs/0.12.1/modules/CloudantV1.PostDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.PostDocumentConstants.html new file mode 100644 index 000000000..16d77d37e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostDocumentConstants.html @@ -0,0 +1,2 @@ +PostDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postDocument operation.

+

Enumerations

Batch
ContentType
diff --git a/docs/0.12.1/modules/CloudantV1.PostExplainConstants.html b/docs/0.12.1/modules/CloudantV1.PostExplainConstants.html new file mode 100644 index 000000000..d232ddc0c --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostExplainConstants.html @@ -0,0 +1,2 @@ +PostExplainConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postExplain operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostFindAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostFindAsStreamConstants.html new file mode 100644 index 000000000..cc0009dbd --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostFindAsStreamConstants.html @@ -0,0 +1,2 @@ +PostFindAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postFindAsStream operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostFindConstants.html b/docs/0.12.1/modules/CloudantV1.PostFindConstants.html new file mode 100644 index 000000000..e83a046de --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostFindConstants.html @@ -0,0 +1,2 @@ +PostFindConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postFind operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostIndexConstants.html b/docs/0.12.1/modules/CloudantV1.PostIndexConstants.html new file mode 100644 index 000000000..3c7354738 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostIndexConstants.html @@ -0,0 +1,2 @@ +PostIndexConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postIndex operation.

+

Enumerations

Type
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionExplainConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionExplainConstants.html new file mode 100644 index 000000000..f3b79827e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionExplainConstants.html @@ -0,0 +1,2 @@ +PostPartitionExplainConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostPartitionExplainConstants

Constants for the postPartitionExplain operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionFindAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionFindAsStreamConstants.html new file mode 100644 index 000000000..8cc5ac7fa --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionFindAsStreamConstants.html @@ -0,0 +1,2 @@ +PostPartitionFindAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostPartitionFindAsStreamConstants

Constants for the postPartitionFindAsStream operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionFindConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionFindConstants.html new file mode 100644 index 000000000..93d22fb12 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionFindConstants.html @@ -0,0 +1,2 @@ +PostPartitionFindConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postPartitionFind operation.

+

Enumerations

Sort
Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionSearchAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionSearchAsStreamConstants.html new file mode 100644 index 000000000..b9fa262a7 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionSearchAsStreamConstants.html @@ -0,0 +1,2 @@ +PostPartitionSearchAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostPartitionSearchAsStreamConstants

Constants for the postPartitionSearchAsStream operation.

+

Enumerations

Stale
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionSearchConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionSearchConstants.html new file mode 100644 index 000000000..fab57ebe9 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionSearchConstants.html @@ -0,0 +1,2 @@ +PostPartitionSearchConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostPartitionSearchConstants

Constants for the postPartitionSearch operation.

+

Enumerations

Stale
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionViewAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionViewAsStreamConstants.html new file mode 100644 index 000000000..d8b2db192 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionViewAsStreamConstants.html @@ -0,0 +1,2 @@ +PostPartitionViewAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PostPartitionViewAsStreamConstants

Constants for the postPartitionViewAsStream operation.

+

Enumerations

Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostPartitionViewConstants.html b/docs/0.12.1/modules/CloudantV1.PostPartitionViewConstants.html new file mode 100644 index 000000000..0da4d10a8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostPartitionViewConstants.html @@ -0,0 +1,2 @@ +PostPartitionViewConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postPartitionView operation.

+

Enumerations

Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostReplicatorConstants.html b/docs/0.12.1/modules/CloudantV1.PostReplicatorConstants.html new file mode 100644 index 000000000..7bdc3b44f --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostReplicatorConstants.html @@ -0,0 +1,2 @@ +PostReplicatorConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postReplicator operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.PostSearchAnalyzeConstants.html b/docs/0.12.1/modules/CloudantV1.PostSearchAnalyzeConstants.html new file mode 100644 index 000000000..c8ed78ff5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostSearchAnalyzeConstants.html @@ -0,0 +1,2 @@ +PostSearchAnalyzeConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postSearchAnalyze operation.

+

Enumerations

Analyzer
diff --git a/docs/0.12.1/modules/CloudantV1.PostSearchAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostSearchAsStreamConstants.html new file mode 100644 index 000000000..264a2403a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostSearchAsStreamConstants.html @@ -0,0 +1,2 @@ +PostSearchAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postSearchAsStream operation.

+

Enumerations

Stale
diff --git a/docs/0.12.1/modules/CloudantV1.PostSearchConstants.html b/docs/0.12.1/modules/CloudantV1.PostSearchConstants.html new file mode 100644 index 000000000..022e43a41 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostSearchConstants.html @@ -0,0 +1,2 @@ +PostSearchConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postSearch operation.

+

Enumerations

Stale
diff --git a/docs/0.12.1/modules/CloudantV1.PostViewAsStreamConstants.html b/docs/0.12.1/modules/CloudantV1.PostViewAsStreamConstants.html new file mode 100644 index 000000000..3cc495423 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostViewAsStreamConstants.html @@ -0,0 +1,2 @@ +PostViewAsStreamConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postViewAsStream operation.

+

Enumerations

Update
diff --git a/docs/0.12.1/modules/CloudantV1.PostViewConstants.html b/docs/0.12.1/modules/CloudantV1.PostViewConstants.html new file mode 100644 index 000000000..00e037bf5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PostViewConstants.html @@ -0,0 +1,2 @@ +PostViewConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the postView operation.

+

Enumerations

Update
diff --git a/docs/0.12.1/modules/CloudantV1.PutCloudantSecurityConfigurationConstants.html b/docs/0.12.1/modules/CloudantV1.PutCloudantSecurityConfigurationConstants.html new file mode 100644 index 000000000..b86a7abeb --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutCloudantSecurityConfigurationConstants.html @@ -0,0 +1,2 @@ +PutCloudantSecurityConfigurationConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PutCloudantSecurityConfigurationConstants

Constants for the putCloudantSecurityConfiguration operation.

+

Enumerations

Cloudant
diff --git a/docs/0.12.1/modules/CloudantV1.PutDesignDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.PutDesignDocumentConstants.html new file mode 100644 index 000000000..776b5b04c --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutDesignDocumentConstants.html @@ -0,0 +1,2 @@ +PutDesignDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the putDesignDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.PutDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.PutDocumentConstants.html new file mode 100644 index 000000000..eddd61fba --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutDocumentConstants.html @@ -0,0 +1,2 @@ +PutDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the putDocument operation.

+

Enumerations

Batch
ContentType
diff --git a/docs/0.12.1/modules/CloudantV1.PutLocalDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.PutLocalDocumentConstants.html new file mode 100644 index 000000000..92cca40a4 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutLocalDocumentConstants.html @@ -0,0 +1,2 @@ +PutLocalDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the putLocalDocument operation.

+

Enumerations

Batch
ContentType
diff --git a/docs/0.12.1/modules/CloudantV1.PutReplicationDocumentConstants.html b/docs/0.12.1/modules/CloudantV1.PutReplicationDocumentConstants.html new file mode 100644 index 000000000..a2bdb1f87 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutReplicationDocumentConstants.html @@ -0,0 +1,2 @@ +PutReplicationDocumentConstants | @ibm-cloud/cloudant - v0.12.1

Namespace PutReplicationDocumentConstants

Constants for the putReplicationDocument operation.

+

Enumerations

Batch
diff --git a/docs/0.12.1/modules/CloudantV1.PutSecurityConstants.html b/docs/0.12.1/modules/CloudantV1.PutSecurityConstants.html new file mode 100644 index 000000000..8369396e8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.PutSecurityConstants.html @@ -0,0 +1,2 @@ +PutSecurityConstants | @ibm-cloud/cloudant - v0.12.1

Constants for the putSecurity operation.

+

Enumerations

Cloudant
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationCreateTargetParameters.html b/docs/0.12.1/modules/CloudantV1.ReplicationCreateTargetParameters.html new file mode 100644 index 000000000..88e348e96 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationCreateTargetParameters.html @@ -0,0 +1 @@ +ReplicationCreateTargetParameters | @ibm-cloud/cloudant - v0.12.1

Namespace ReplicationCreateTargetParameters

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationDatabase.html b/docs/0.12.1/modules/CloudantV1.ReplicationDatabase.html new file mode 100644 index 000000000..b35896ac8 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationDatabase.html @@ -0,0 +1 @@ +ReplicationDatabase | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuth.html b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuth.html new file mode 100644 index 000000000..8116ebb79 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuth.html @@ -0,0 +1 @@ +ReplicationDatabaseAuth | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthBasic.html b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthBasic.html new file mode 100644 index 000000000..7ad8c6a08 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthBasic.html @@ -0,0 +1 @@ +ReplicationDatabaseAuthBasic | @ibm-cloud/cloudant - v0.12.1

Namespace ReplicationDatabaseAuthBasic

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthIam.html b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthIam.html new file mode 100644 index 000000000..bd429986e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationDatabaseAuthIam.html @@ -0,0 +1 @@ +ReplicationDatabaseAuthIam | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ReplicationDocument.html b/docs/0.12.1/modules/CloudantV1.ReplicationDocument.html new file mode 100644 index 000000000..05ac18314 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ReplicationDocument.html @@ -0,0 +1 @@ +ReplicationDocument | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Revisions.html b/docs/0.12.1/modules/CloudantV1.Revisions.html new file mode 100644 index 000000000..b5b4415e2 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Revisions.html @@ -0,0 +1 @@ +Revisions | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.RevsDiff.html b/docs/0.12.1/modules/CloudantV1.RevsDiff.html new file mode 100644 index 000000000..0453376d9 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.RevsDiff.html @@ -0,0 +1 @@ +RevsDiff | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerDocsResult.html b/docs/0.12.1/modules/CloudantV1.SchedulerDocsResult.html new file mode 100644 index 000000000..f2acf5c71 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerDocsResult.html @@ -0,0 +1 @@ +SchedulerDocsResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerDocument.Constants.html b/docs/0.12.1/modules/CloudantV1.SchedulerDocument.Constants.html new file mode 100644 index 000000000..13fc1277e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerDocument.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerDocument.html b/docs/0.12.1/modules/CloudantV1.SchedulerDocument.html new file mode 100644 index 000000000..61ad1f913 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerDocument.html @@ -0,0 +1 @@ +SchedulerDocument | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerInfo.html b/docs/0.12.1/modules/CloudantV1.SchedulerInfo.html new file mode 100644 index 000000000..27d956628 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerInfo.html @@ -0,0 +1 @@ +SchedulerInfo | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerJob.html b/docs/0.12.1/modules/CloudantV1.SchedulerJob.html new file mode 100644 index 000000000..8c3e6efde --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerJob.html @@ -0,0 +1 @@ +SchedulerJob | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerJobEvent.html b/docs/0.12.1/modules/CloudantV1.SchedulerJobEvent.html new file mode 100644 index 000000000..b4949d151 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerJobEvent.html @@ -0,0 +1 @@ +SchedulerJobEvent | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SchedulerJobsResult.html b/docs/0.12.1/modules/CloudantV1.SchedulerJobsResult.html new file mode 100644 index 000000000..7640831af --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SchedulerJobsResult.html @@ -0,0 +1 @@ +SchedulerJobsResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchAnalyzeResult.html b/docs/0.12.1/modules/CloudantV1.SearchAnalyzeResult.html new file mode 100644 index 000000000..95e869977 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchAnalyzeResult.html @@ -0,0 +1 @@ +SearchAnalyzeResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchDiskSizeInformation.html b/docs/0.12.1/modules/CloudantV1.SearchDiskSizeInformation.html new file mode 100644 index 000000000..b0fa80f57 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchDiskSizeInformation.html @@ -0,0 +1 @@ +SearchDiskSizeInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchIndexDefinition.html b/docs/0.12.1/modules/CloudantV1.SearchIndexDefinition.html new file mode 100644 index 000000000..0ad6d24de --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchIndexDefinition.html @@ -0,0 +1 @@ +SearchIndexDefinition | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchIndexDiskSize.html b/docs/0.12.1/modules/CloudantV1.SearchIndexDiskSize.html new file mode 100644 index 000000000..b2186375a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchIndexDiskSize.html @@ -0,0 +1 @@ +SearchIndexDiskSize | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchIndexInfo.html b/docs/0.12.1/modules/CloudantV1.SearchIndexInfo.html new file mode 100644 index 000000000..452b22d2f --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchIndexInfo.html @@ -0,0 +1 @@ +SearchIndexInfo | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchInfoResult.html b/docs/0.12.1/modules/CloudantV1.SearchInfoResult.html new file mode 100644 index 000000000..0f3ac9684 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchInfoResult.html @@ -0,0 +1 @@ +SearchInfoResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchResult.html b/docs/0.12.1/modules/CloudantV1.SearchResult.html new file mode 100644 index 000000000..9a5ecf6c7 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchResult.html @@ -0,0 +1 @@ +SearchResult | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SearchResultProperties.html b/docs/0.12.1/modules/CloudantV1.SearchResultProperties.html new file mode 100644 index 000000000..ef97529ab --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchResultProperties.html @@ -0,0 +1 @@ +SearchResultProperties | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SearchResultRow.html b/docs/0.12.1/modules/CloudantV1.SearchResultRow.html new file mode 100644 index 000000000..39fce92b9 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SearchResultRow.html @@ -0,0 +1 @@ +SearchResultRow | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.Security.html b/docs/0.12.1/modules/CloudantV1.Security.html new file mode 100644 index 000000000..0ed708f46 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.Security.html @@ -0,0 +1 @@ +Security | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SecurityObject.html b/docs/0.12.1/modules/CloudantV1.SecurityObject.html new file mode 100644 index 000000000..7f5bb5004 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SecurityObject.html @@ -0,0 +1 @@ +SecurityObject | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SelectorHint.Constants.html b/docs/0.12.1/modules/CloudantV1.SelectorHint.Constants.html new file mode 100644 index 000000000..f2b12749c --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SelectorHint.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.SelectorHint.html b/docs/0.12.1/modules/CloudantV1.SelectorHint.html new file mode 100644 index 000000000..1378819bd --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SelectorHint.html @@ -0,0 +1 @@ +SelectorHint | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ServerInformation.html b/docs/0.12.1/modules/CloudantV1.ServerInformation.html new file mode 100644 index 000000000..684d3ee4a --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ServerInformation.html @@ -0,0 +1 @@ +ServerInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ServerVendor.Constants.html b/docs/0.12.1/modules/CloudantV1.ServerVendor.Constants.html new file mode 100644 index 000000000..cffcf511e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ServerVendor.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ServerVendor.html b/docs/0.12.1/modules/CloudantV1.ServerVendor.html new file mode 100644 index 000000000..cff8df258 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ServerVendor.html @@ -0,0 +1 @@ +ServerVendor | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SessionAuthentication.html b/docs/0.12.1/modules/CloudantV1.SessionAuthentication.html new file mode 100644 index 000000000..1bb219709 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SessionAuthentication.html @@ -0,0 +1 @@ +SessionAuthentication | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.SessionInformation.html b/docs/0.12.1/modules/CloudantV1.SessionInformation.html new file mode 100644 index 000000000..b0ac5facd --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.SessionInformation.html @@ -0,0 +1 @@ +SessionInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ShardsInformation.html b/docs/0.12.1/modules/CloudantV1.ShardsInformation.html new file mode 100644 index 000000000..5d11b643e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ShardsInformation.html @@ -0,0 +1 @@ +ShardsInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ThroughputInformation.html b/docs/0.12.1/modules/CloudantV1.ThroughputInformation.html new file mode 100644 index 000000000..839f402ab --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ThroughputInformation.html @@ -0,0 +1 @@ +ThroughputInformation | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.UpInformation.Constants.html b/docs/0.12.1/modules/CloudantV1.UpInformation.Constants.html new file mode 100644 index 000000000..49e8babe5 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UpInformation.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.UpInformation.html b/docs/0.12.1/modules/CloudantV1.UpInformation.html new file mode 100644 index 000000000..2efeaa402 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UpInformation.html @@ -0,0 +1 @@ +UpInformation | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.UpdatesPending.html b/docs/0.12.1/modules/CloudantV1.UpdatesPending.html new file mode 100644 index 000000000..00b22c7dd --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UpdatesPending.html @@ -0,0 +1 @@ +UpdatesPending | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.UserContext.Constants.html b/docs/0.12.1/modules/CloudantV1.UserContext.Constants.html new file mode 100644 index 000000000..f6a24d1ff --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UserContext.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.UserContext.html b/docs/0.12.1/modules/CloudantV1.UserContext.html new file mode 100644 index 000000000..bee631141 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UserContext.html @@ -0,0 +1 @@ +UserContext | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.UuidsResult.html b/docs/0.12.1/modules/CloudantV1.UuidsResult.html new file mode 100644 index 000000000..e47312ed7 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.UuidsResult.html @@ -0,0 +1 @@ +UuidsResult | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ViewQueriesResult.html b/docs/0.12.1/modules/CloudantV1.ViewQueriesResult.html new file mode 100644 index 000000000..34ba2fb22 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ViewQueriesResult.html @@ -0,0 +1 @@ +ViewQueriesResult | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ViewQuery.Constants.html b/docs/0.12.1/modules/CloudantV1.ViewQuery.Constants.html new file mode 100644 index 000000000..d82125db7 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ViewQuery.Constants.html @@ -0,0 +1 @@ +Constants | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ViewQuery.html b/docs/0.12.1/modules/CloudantV1.ViewQuery.html new file mode 100644 index 000000000..9fd0dfc98 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ViewQuery.html @@ -0,0 +1 @@ +ViewQuery | @ibm-cloud/cloudant - v0.12.1

Namespaces

Constants

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.ViewResult.html b/docs/0.12.1/modules/CloudantV1.ViewResult.html new file mode 100644 index 000000000..a76374d9e --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ViewResult.html @@ -0,0 +1 @@ +ViewResult | @ibm-cloud/cloudant - v0.12.1
diff --git a/docs/0.12.1/modules/CloudantV1.ViewResultRow.html b/docs/0.12.1/modules/CloudantV1.ViewResultRow.html new file mode 100644 index 000000000..4f3df8758 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.ViewResultRow.html @@ -0,0 +1 @@ +ViewResultRow | @ibm-cloud/cloudant - v0.12.1

Interfaces

Transport
diff --git a/docs/0.12.1/modules/CloudantV1.html b/docs/0.12.1/modules/CloudantV1.html new file mode 100644 index 000000000..963b61765 --- /dev/null +++ b/docs/0.12.1/modules/CloudantV1.html @@ -0,0 +1,4 @@ +CloudantV1 | @ibm-cloud/cloudant - v0.12.1

Namespace CloudantV1


+

interfaces

+
+

Namespaces

ActiveTask
ActivityTrackerEvents
AllDocsQueriesResult
AllDocsQuery
AllDocsResult
Analyzer
AnalyzerConfiguration
ApiKeysResult
Attachment
BulkDocs
BulkGetQueryDocument
BulkGetResult
BulkGetResultDocument
BulkGetResultItem
CapacityThroughputInformation
CapacityThroughputInformationCurrent
CapacityThroughputInformationTarget
Change
ChangesResult
ChangesResultItem
ContentInformationSizes
CorsInformation
CurrentThroughputInformation
CurrentThroughputInformationThroughput
DatabaseInformation
DatabaseInformationCluster
DatabaseInformationProps
DbEvent
DbsInfoResult
DbUpdates
DeleteAttachmentConstants
DeleteDesignDocumentConstants
DeleteDocumentConstants
DeleteIndexConstants
DeleteLocalDocumentConstants
DeleteReplicationDocumentConstants
DesignDocument
DesignDocumentInformation
DesignDocumentOptions
DesignDocumentViewIndex
DesignDocumentViewsMapReduce
DocsResultRow
DocsResultRowValue
Document
DocumentResult
DocumentRevisionStatus
DocumentShardInfo
ExecutionStats
ExplainResult
ExplainResultMrArgs
ExplainResultOpts
FindResult
GetDbUpdatesConstants
GetLocalDocumentConstants
GetSchedulerDocsConstants
IndexAnalysis
IndexAnalysisExclusionReason
IndexCandidate
IndexDefinition
IndexesInformation
IndexField
IndexInformation
IndexResult
IndexTextOperatorDefaultField
MembershipInformation
Ok
PartitionedIndexesDetailedInformation
PartitionedIndexesInformation
PartitionInformation
PartitionInformationIndexes
PartitionInformationIndexesIndexes
PartitionInformationSizes
PostActivityTrackerEventsConstants
PostChangesAsStreamConstants
PostChangesConstants
PostDesignDocsQueriesConstants
PostDocumentConstants
PostExplainConstants
PostFindAsStreamConstants
PostFindConstants
PostIndexConstants
PostPartitionExplainConstants
PostPartitionFindAsStreamConstants
PostPartitionFindConstants
PostPartitionSearchAsStreamConstants
PostPartitionSearchConstants
PostPartitionViewAsStreamConstants
PostPartitionViewConstants
PostReplicatorConstants
PostSearchAnalyzeConstants
PostSearchAsStreamConstants
PostSearchConstants
PostViewAsStreamConstants
PostViewConstants
PutCloudantSecurityConfigurationConstants
PutDesignDocumentConstants
PutDocumentConstants
PutLocalDocumentConstants
PutReplicationDocumentConstants
PutSecurityConstants
ReplicationCreateTargetParameters
ReplicationDatabase
ReplicationDatabaseAuth
ReplicationDatabaseAuthBasic
ReplicationDatabaseAuthIam
ReplicationDocument
Revisions
RevsDiff
SchedulerDocsResult
SchedulerDocument
SchedulerInfo
SchedulerJob
SchedulerJobEvent
SchedulerJobsResult
SearchAnalyzeResult
SearchDiskSizeInformation
SearchIndexDefinition
SearchIndexDiskSize
SearchIndexInfo
SearchInfoResult
SearchResult
SearchResultProperties
SearchResultRow
Security
SecurityObject
SelectorHint
ServerInformation
ServerVendor
SessionAuthentication
SessionInformation
ShardsInformation
ThroughputInformation
UpdatesPending
UpInformation
UserContext
UuidsResult
ViewQueriesResult
ViewQuery
ViewResult
ViewResultRow

Classes

ActiveTask
ActivityTrackerEvents
AllDocsQueriesResult
AllDocsQuery
AllDocsResult
Analyzer
AnalyzerConfiguration
ApiKeysResult
Attachment
BulkDocs
BulkGetQueryDocument
BulkGetResult
BulkGetResultDocument
BulkGetResultItem
CapacityThroughputInformation
CapacityThroughputInformationCurrent
CapacityThroughputInformationTarget
Change
ChangesResult
ChangesResultItem
ContentInformationSizes
CorsInformation
CurrentThroughputInformation
CurrentThroughputInformationThroughput
DatabaseInformation
DatabaseInformationCluster
DatabaseInformationProps
DbEvent
DbsInfoResult
DbUpdates
DesignDocument
DesignDocumentInformation
DesignDocumentOptions
DesignDocumentViewIndex
DesignDocumentViewsMapReduce
DocsResultRow
DocsResultRowValue
Document
DocumentResult
DocumentRevisionStatus
DocumentShardInfo
ExecutionStats
ExplainResult
ExplainResultMrArgs
ExplainResultOpts
FindResult
IndexAnalysis
IndexAnalysisExclusionReason
IndexCandidate
IndexDefinition
IndexesInformation
IndexField
IndexInformation
IndexResult
IndexTextOperatorDefaultField
JsonObject
MembershipInformation
Ok
PartitionedIndexesDetailedInformation
PartitionedIndexesInformation
PartitionInformation
PartitionInformationIndexes
PartitionInformationIndexesIndexes
PartitionInformationSizes
ReplicationCreateTargetParameters
ReplicationDatabase
ReplicationDatabaseAuth
ReplicationDatabaseAuthBasic
ReplicationDatabaseAuthIam
ReplicationDocument
Revisions
RevsDiff
SchedulerDocsResult
SchedulerDocument
SchedulerInfo
SchedulerJob
SchedulerJobEvent
SchedulerJobsResult
SearchAnalyzeResult
SearchDiskSizeInformation
SearchIndexDefinition
SearchIndexDiskSize
SearchIndexInfo
SearchInfoResult
SearchResult
SearchResultProperties
SearchResultRow
Security
SecurityObject
SelectorHint
ServerInformation
ServerVendor
SessionAuthentication
SessionInformation
ShardsInformation
ThroughputInformation
UpdatesPending
UpInformation
UserContext
UuidsResult
ViewQueriesResult
ViewQuery
ViewResult
ViewResultRow

Interfaces

DeleteAttachmentParams
DeleteDatabaseParams
DeleteDesignDocumentParams
DeleteDocumentParams
DeleteIndexParams
DeleteLocalDocumentParams
DeleteReplicationDocumentParams
EmptyObject
GetActiveTasksParams
GetActivityTrackerEventsParams
GetAllDbsParams
GetAttachmentParams
GetCapacityThroughputInformationParams
GetCorsInformationParams
GetCurrentThroughputInformationParams
GetDatabaseInformationParams
GetDbUpdatesParams
GetDesignDocumentInformationParams
GetDesignDocumentParams
GetDocumentAsMixedParams
GetDocumentAsRelatedParams
GetDocumentAsStreamParams
GetDocumentParams
GetDocumentShardsInfoParams
GetIndexesInformationParams
GetLocalDocumentParams
GetMembershipInformationParams
GetPartitionInformationParams
GetReplicationDocumentParams
GetSchedulerDocsParams
GetSchedulerDocumentParams
GetSchedulerJobParams
GetSchedulerJobsParams
GetSearchDiskSizeParams
GetSearchInfoParams
GetSecurityParams
GetServerInformationParams
GetSessionInformationParams
GetShardsInformationParams
GetUpInformationParams
GetUuidsParams
HeadAttachmentParams
HeadDatabaseParams
HeadDesignDocumentParams
HeadDocumentParams
HeadLocalDocumentParams
HeadReplicationDocumentParams
HeadSchedulerDocumentParams
HeadSchedulerJobParams
HeadUpInformationParams
PostActivityTrackerEventsParams
PostAllDocsAsStreamParams
PostAllDocsParams
PostAllDocsQueriesAsStreamParams
PostAllDocsQueriesParams
PostApiKeysParams
PostBulkDocsParams
PostBulkGetAsMixedParams
PostBulkGetAsRelatedParams
PostBulkGetAsStreamParams
PostBulkGetParams
PostChangesAsStreamParams
PostChangesParams
PostDbsInfoParams
PostDesignDocsParams
PostDesignDocsQueriesParams
PostDocumentParams
PostExplainParams
PostFindAsStreamParams
PostFindParams
PostIndexParams
PostPartitionAllDocsAsStreamParams
PostPartitionAllDocsParams
PostPartitionExplainParams
PostPartitionFindAsStreamParams
PostPartitionFindParams
PostPartitionSearchAsStreamParams
PostPartitionSearchParams
PostPartitionViewAsStreamParams
PostPartitionViewParams
PostReplicatorParams
PostRevsDiffParams
PostSearchAnalyzeParams
PostSearchAsStreamParams
PostSearchParams
PostViewAsStreamParams
PostViewParams
PostViewQueriesAsStreamParams
PostViewQueriesParams
PutAttachmentParams
PutCapacityThroughputConfigurationParams
PutCloudantSecurityConfigurationParams
PutCorsConfigurationParams
PutDatabaseParams
PutDesignDocumentParams
PutDocumentParams
PutLocalDocumentParams
PutReplicationDocumentParams
PutSecurityParams
Response

Type Aliases

Callback
diff --git a/docs/0.12.1/types/CloudantV1.Callback.html b/docs/0.12.1/types/CloudantV1.Callback.html new file mode 100644 index 000000000..eb7ff6154 --- /dev/null +++ b/docs/0.12.1/types/CloudantV1.Callback.html @@ -0,0 +1,2 @@ +Callback | @ibm-cloud/cloudant - v0.12.1
Callback: (error: any, response?: Response<T>) => void

The callback for a service request.

+

Type Parameters

  • T

Type declaration

    • (error: any, response?: Response<T>): void
    • Parameters

      Returns void

diff --git a/docs/0.12.1/types/CouchdbSessionAuthenticatorOptions.html b/docs/0.12.1/types/CouchdbSessionAuthenticatorOptions.html new file mode 100644 index 000000000..041ef1fbe --- /dev/null +++ b/docs/0.12.1/types/CouchdbSessionAuthenticatorOptions.html @@ -0,0 +1,4 @@ +CouchdbSessionAuthenticatorOptions | @ibm-cloud/cloudant - v0.12.1

Type Alias CouchdbSessionAuthenticatorOptions

CouchdbSessionAuthenticatorOptions: { password: string; username: string }

Configuration options for CouchDB session authentication.

+

Type declaration

  • password: string

    The password to be used in CouchDB session authentication.

    +
  • username: string

    The username to be used in CouchDB session authentication.

    +
diff --git a/docs/latest b/docs/latest index 8c989c25a..7c58bb742 120000 --- a/docs/latest +++ b/docs/latest @@ -1 +1 @@ -./0.12.0 \ No newline at end of file +./0.12.1 \ No newline at end of file diff --git a/index.html b/index.html index 8d5e67ad7..0d5ea8298 100644 --- a/index.html +++ b/index.html @@ -43,6 +43,7 @@

IBM Cloudant Node SDK Documentation

  • 0.10.3
  • 0.11.0
  • 0.12.0
  • +
  • 0.12.1
  • 0.2.0
  • 0.2.1
  • 0.3.0