lib

package

v1.0.3 Latest Latest Go to latest Published: Mar 27, 2023 License: MIT Imports: 0 Imported by: 8

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/snowpal/pitch-building-blocks-sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants

Constants ¶

View Source

const (
	XApiKey      = "REPLACE_WITH_YOUR_KEY"
	XProductCode = "REPLACE_WITH_PRODUCT_CODE"
)

View Source

const (
	RouteAttributesGetDisplayableAttributes        = "app/resource/attributes"
	RouteAttributesUpdateKeyDisplayAttributes      = "keys/%s/attributes"
	RouteAttributesUpdateBlockDisplayAttributes    = "blocks/%s/attributes?keyId=%s"
	RouteAttributesUpdateKeyPodDisplayAttributes   = "pods/%s/attributes?keyId=%s"
	RouteAttributesUpdateBlockPodDisplayAttributes = "block-pods/%s/attributes?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlocksGetBlocks                             = "keys/%s/blocks?filter=%s&batchIndex=%s&aclWriteOrHigher=%s"
	RouteBlocksAddBlock                              = "keys/%s/blocks"
	RouteBlocksGetBlocksLinkedToPod                  = "pods/:id/linked-to/blocks?keyId=%s"
	RouteBlocksAddBlockBasedOnTemplate               = "keys/%s/blocks/by-template?templateId=%s&excludePods=%s&excludeTasks=%s"
	RouteBlocksLinkBlockToKey                        = "keys/%s/blocks/%s/link"
	RouteBlocksUnlinkBlockFromKey                    = "keys/%s/blocks/%s/unlink"
	RouteBlocksGetBlocksAvailableToBeLinkedToThisKey = "keys/%s/blocks/available-to-link"
	RouteBlocksGetBlock                              = "blocks/%s?keyId=%s"
	RouteBlocksUpdateBlock                           = "blocks/%s?keyId=%s"
	RouteBlocksAddBlockTypeToBlock                   = "blocks/%s/block-types/%s?keyId=%s"
	RouteBlocksDeleteBlockTypeFromBlock              = "blocks/%s/block-types?keyId=%s"
	RouteBlocksAddScaleToBlock                       = "blocks/%s/scales/%s?keyId=%s"
	RouteBlocksDeleteScaleFromBlock                  = "blocks/%s/scales?keyId=%s"
	RouteBlocksUpdateBlockScaleValue                 = "blocks/%s/scale-value?keyId=%s"
	RouteBlocksUpdateBlockDescription                = "blocks/%s/description?keyId=%s"
	RouteBlocksArchiveBlock                          = "blocks/%s/archive?keyId=%s"
	RouteBlocksUnarchiveBlock                        = "blocks/%s/unarchive?keyId=%s"
	RouteBlocksGetArchivedBlocks                     = "blocks/archived?keyId=%s&batchIndex=%s"
	RouteBlocksBulkArchiveBlocks                     = "blocks/archive?keyId=%s"
	RouteBlocksAllowArchivalOfBlock                  = "blocks/%s/allow-archival?keyId=%s"
	RouteBlocksCopyBlock                             = "blocks/%s/copy?keyId=%s&allTasks=%s&podIds=%s&allPods=%s&allChecklists=%s&targetKeyId=%s"
	RouteBlocksMoveBlock                             = "blocks/%s/move?keyId=%s&targetKeyId=%s"
)

View Source

const (
	RouteBlocksGetBlockAttachments   = "blocks/%s/attachments?keyId=%s"
	RouteBlocksAddBlockAttachment    = "blocks/%s/attachments?keyId=%s"
	RouteBlocksRenameBlockAttachment = "block-attachments/%s/rename?keyId=%s&blockId=%s"
	RouteBlocksDeleteBlockAttachment = "block-attachments/%s?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlocksGetLinkedBlockPods        = "charts/keys/%s/blocks/%s/linked-resources"
	RouteBlocksGetScaleValuesForScale    = "charts/keys/%s/blocks/%s/scales/%s/grades"
	RouteBlocksGetTaskStatusForBlock     = "charts/keys/%s/blocks/%s/task-status"
	RouteBlocksGetBlockGradesForStudents = "blocks/%s/students/all/grades?keyId=%s"
)

View Source

const (
	RouteBlocksGetBlockChecklists         = "blocks/%s/checklists?keyId=%s"
	RouteBlocksAddBlockChecklist          = "blocks/%s/checklists?keyId=%s"
	RouteBlocksReorderBlockChecklists     = "blocks/%s/checklists/reorder?keyId=%s"
	RouteBlocksDeleteBlockChecklist       = "blocks/%s/checklists/%s?keyId=%s"
	RouteBlocksRenameBlockChecklist       = "blocks/%s/checklists/%s?keyId=%s"
	RouteBlocksAddBlockChecklistItem      = "blocks/%s/checklists/%s/checklist-items?keyId=%s"
	RouteBlocksUpdateBlockChecklistItem   = "blocks/%s/checklists/%s/checklist-items/%s?keyId=%s"
	RouteBlocksDeleteBlockChecklistItem   = "blocks/%s/checklists/%s/checklist-items/%s?keyId=%s"
	RouteBlocksReorderBlockChecklistItems = "blocks/%s/checklists/%s/checklist-items/reorder?keyId=%s"
)

View Source

const (
	RouteBlocksGetBlockComments   = "blocks/%s/comments?keyId=%s"
	RouteBlocksAddBlockComment    = "blocks/%s/comments?keyId=%s"
	RouteBlocksUpdateBlockComment = "block-comments/%s?keyId=%s&blockId=%s"
	RouteBlocksDeleteBlockComment = "block-comments/%s?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlocksGetBlockNotes   = "blocks/%s/notes?keyId=%s"
	RouteBlocksAddBlockNote    = "blocks/%s/notes?keyId=%s"
	RouteBlocksUpdateBlockNote = "block-notes/%s?keyId=%s&blockId=%s"
	RouteBlocksDeleteBlockNote = "block-notes/%s?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlocksGetBlockTasks     = "blocks/%s/tasks?keyId=%s"
	RouteBlocksAddBlockTask      = "blocks/%s/tasks?keyId=%s"
	RouteBlocksUpdateBlockTask   = "block-tasks/%s?keyId=%s&blockId=%s"
	RouteBlocksDeleteBlockTask   = "block-tasks/%s?keyId=%s&blockId=%s"
	RouteBlocksAssignBlockTask   = "block-tasks/%s/assign?keyId=%s&blockId=%s"
	RouteBlocksUnassignBlockTask = "block-tasks/%s/unassign?keyId=%s&blockId=%s"
	RouteBlocksReorderBlockTasks = "blocks/%s/tasks/reorder?keyId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPods                          = "blocks/%s/pods?batchIndex=%s&keyId=%s"
	RouteBlockPodsAddBlockPod                           = "blocks/%s/pods?keyId=%s"
	RouteBlockPodsAddBlockPodBasedOnTemplate            = "blocks/%s/pods/by-template?keyId=%s&templateId=%s&excludeTasks=%s"
	RouteBlockPodsLinkPodToBlock                        = "blocks/%s/pods/%s/link?keyId=%s"
	RouteBlockPodsUnlinkPodFromBlock                    = "blocks/%s/pods/%s/unlink?keyId=%s"
	RouteBlockPodsGetBlockPod                           = "block-pods/%s?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPod                        = "block-pods/%s?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodCompletionStatus        = "block-pods/%s/by-completion-status?keyId=%s&blockId=%s"
	RouteBlockPodsAddPodTypeToBlockPod                  = "block-pods/%s/pod-types/%s?keyId=%s&blockId=%s"
	RouteBlockPodsDeletePodTypeFromBlockPod             = "block-pods/%s/pod-types?keyId=%s&blockId=%s"
	RouteBlockPodsAddScaleToBlockPod                    = "block-pods/%s/scales/%s?keyId=%s&blockId=%s"
	RouteBlockPodsDeleteScaleFromBlockPod               = "block-pods/%s/scales?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodScaleValue              = "block-pods/%s/scale-value?keyId=%s&blockId=%s"
	RouteBlockPodsArchiveBlockPod                       = "block-pods/%s/archive?keyId=%s&block=%s"
	RouteBlockPodsGetArchivedBlockPods                  = "block-pods/archived?batchIndex=%s&keyId=%s&blockId=%s"
	RouteBlockPodsGetPodsAvailableToBeLinkedToThisBlock = "blocks/%s/pods/available-to-link?keyId=%s"
	RouteBlockPodsUnarchiveBlockPod                     = "block-pods/%s/unarchive?keyId=%s&blockId=%s"
	RouteBlockPodsBulkArchiveBlockPods                  = "block-pods/archive?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodDescription             = "block-pods/%s/description?keyId=%s&blockId=%s"
	RouteBlockPodsAllowArchivalOfBlockPod               = "block-pods/%s/allow-archival?keyId=%s&blockId=%s"
	RouteBlockPodsCopyBlockPod                          = "block-pods/%s/copy?keyId=%s&blockId=%s&allTasks=%s&allChecklists=%s&targetKeyId=%s&targetBlockId=%s"
	RouteBlockPodsMoveBlockPod                          = "block-pods/%s/move?keyId=%s&blockId=%s&targetKeyId=%s&targetBlockId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodAttachments   = "block-pods/%s/attachments?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodAttachment    = "block-pods/%s/attachments?keyId=%s&blockId=%s"
	RouteBlockPodsRenameBlockPodAttachment = "block-pod-attachments/%s/rename?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsDeleteBlockPodAttachment = "block-pod-attachments/%s?keyId=%s&blockId=%s&podId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodTasksForCharts    = "charts/block-pods/%s/tasks?keyId=%s&blockId=%s"
	RouteBlockPodsGetBlockPodGradesForStudents = "charts/classroom-pods/%s/students/grades?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodChecklists         = "block-pods/%s/checklists?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodChecklist          = "block-pods/%s/checklists?keyId=%s&blockId=%s"
	RouteBlockPodsReorderBlockPodChecklists     = "block-pods/%s/checklists/reorder?keyId=%s&blockId=%s"
	RouteBlockPodsDeleteBlockPodChecklist       = "block-pods/%s/checklists/%s?keyId=%s&blockId=%s"
	RouteBlockPodsRenameBlockPodChecklist       = "block-pods/%s/checklists/%s?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodChecklistItem      = "block-pods/%s/checklists/%s/checklist-items?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodChecklistItem   = "block-pods/%s/checklists/%s/checklist-items/%s?keyId=%s&blockId=%s"
	RouteBlockPodsDeleteBlockPodChecklistItem   = "block-pods/%s/checklists/%s/checklist-items/%s?keyId=%s&blockId=%s"
	RouteBlockPodsReorderBlockPodChecklistItems = "block-pods/%s/checklists/%s/checklist-items/reorder?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodComments   = "block-pods/%s/comments?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodComment    = "block-pods/%s/comments?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodComment = "block-pod-comments/%s?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsDeleteBlockPodComment = "block-pod-comments/%s?keyId=%s&blockId=%s&podId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodNotes   = "block-pods/%s/notes?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodNote    = "block-pods/%s/notes?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodNote = "block-pod-notes/%s?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsDeleteBlockPodNote = "block-pod-notes/%s?keyId=%s&blockId=%s&podId=%s"
)

View Source

const (
	RouteBlockPodsGetBlockPodTasks     = "block-pods/%s/tasks?keyId=%s&blockId=%s"
	RouteBlockPodsAddBlockPodTask      = "block-pods/%s/tasks?keyId=%s&blockId=%s"
	RouteBlockPodsUpdateBlockPodTask   = "block-pod-tasks/%s?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsDeleteBlockPodTask   = "block-pod-tasks/%s?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsAssignBlockPodTask   = "block-pod-tasks/%s/assign?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsUnassignBlockPodTask = "block-pod-tasks/%s/unassign?keyId=%s&blockId=%s&podId=%s"
	RouteBlockPodsReorderBlockPodTasks = "block-pods/%s/tasks/reorder?keyId=%s&blockId=%s"
)

View Source

const (
	RouteBlockTypesGetBlockTypes           = "block-types?includeCounts=%s"
	RouteBlockTypesAddBlockType            = "block-types"
	RouteBlockTypesUpdateBlockType         = "block-types/%s"
	RouteBlockTypesDeleteBlockType         = "block-types/%s"
	RouteBlockTypesGetBlocksUsingBlockType = "block-types/%s/blocks"
)

View Source

const (
	RouteCollaborationGetBlockCollaborators                   = "blocks/%s/acl?keyId=%s"
	RouteCollaborationUpdateBlockAcl                          = "blocks/%s/users/%s/acl?keyId=%s"
	RouteCollaborationUnshareBlockFromCollaborator            = "blocks/%s/users/%s/unshare?keyId=%s"
	RouteCollaborationShareBlockWithCollaborator              = "blocks/%s/users/%s/share?keyId=%s"
	RouteCollaborationShareBlockWithCollaboratorAlongWithPods = "blocks/%s/users/%s/share/with/pods?keyId=%s"
	RouteCollaborationGetUsersThisBlockCanBeSharedWith        = "search/blocks/%s/shareable/users?keyId=%s&token=%s"
	RouteCollaborationBulkShareBlocksWithCollaborators        = "blocks/users/%s/share?keyId=%s"
	RouteCollaborationLeaveBlock                              = "blocks/%s/leave?keyId=%s"
)

View Source

const (
	RouteCollaborationGetBlockPodCollaborators            = "block-pods/%s/acl?keyId=%s&blockId=%s"
	RouteCollaborationShareBlockPodWithCollaborator       = "block-pods/%s/users/%s/share?keyId=%s&blockId=%s"
	RouteCollaborationUnshareBlockPodFromCollaborator     = "block-pods/%s/users/%s/unshare?keyId=%s&blockId=%s"
	RouteCollaborationBulkShareBlockPodsWithCollaborators = "block-pods/users/%s/share?keyId=%s"
	RouteCollaborationGetUsersThisBlockPodCanBeSharedWith = "search/block-pods/%s/shareable/users?keyId=%s&blockId=%s&token=%s"
	RouteCollaborationUpdateBlockPodAcl                   = "block-pods/%s/users/%s/acl?keyId=%s&blockId=%s"
	RouteCollaborationLeaveBlockPod                       = "block-pods/%s/leave?keyId=%s&blockId=%s"
)

View Source

const (
	RouteCollaborationGetKeyPodCollaborators            = "pods/%s/acl?keyId=%s"
	RouteCollaborationShareKeyPodWithCollaborator       = "pods/%s/users/%s/share?keyId=%s"
	RouteCollaborationBulkShareKeyPodsWithCollaborators = "pods/users/%s/share?keyId=%s"
	RouteCollaborationUnshareKeyPodFromCollaborator     = "pods/%s/users/%s/unshare?keyId=%s"
	RouteCollaborationGetUsersThisKeyPodCanBeSharedWith = "search/pods/%s/shareable/users?keyId=%s&token=%s"
	RouteCollaborationUpdateKeyPodAcl                   = "pods/%s/users/%s/acl?keyId=%s"
	RouteCollaborationLeaveKeyPod                       = "pods/%s/leave?keyId=%s"
)

View Source

const (
	RouteConversationsGetUnreadConversationsCount         = "conversations/unread-status"
	RouteConversationsGetUserConversations                = "conversations"
	RouteConversationsAddPrivateOrGroupConversation       = "conversations"
	RouteConversationsGetConversationForGivenUsernames    = "conversations/by-usernames?userNames=%s"
	RouteConversationsSendMessageToAnExistingConversation = "conversations/%s/messages"
	RouteConversationsGetConversation                     = "conversations/%s"
	RouteConversationsDeleteConversation                  = "conversations/%s"
	RouteConversationsLeaveConversation                   = "conversations/%s/leave"
	RouteConversationsArchiveConversation                 = "conversations/%s/archive"
)

View Source

const (
	RouteDashboardGetDashboardDetails              = "dashboard/combined-responses"
	RouteDashboardGetRecentlyModifiedBlocksAndPods = "dashboard/recently-modified"
	RouteDashboardGetUnreadCount                   = "dashboard/unread-count"
	RouteDashboardGetRecentlyModifiedKeys          = "dashboard/recently-modified/keys"
	RouteDashboardGetPodsAndTasksDueShortly        = "dashboard/due-shortly/pods-and-tasks"
	RouteDashboardGetBlocksDueShortly              = "dashboard/due-shortly/blocks"
	RouteDashboardGetUnreadNotifications           = "dashboard/notifications/unread-status"
	RouteDashboardGetUnreadConversations           = "dashboard/conversations/unread-status"
)

View Source

const (
	RouteDashboardGetUserKeysBlocksAndPods           = "charts/dashboard/keys-blocks-pods"
	RouteDashboardGetSystemKeysBlocksAndPods         = "charts/dashboard/system-keys"
	RouteDashboardGetFilteredUserKeysBlocksAndPods   = "charts/dashboard/keys/filters"
	RouteDashboardGetFilteredSystemKeysBlocksAndPods = "charts/dashboard/system-keys/filters"
	RouteDashboardGetBlocksBasedOnBlockTypes         = "charts/dashboard/block-types"
	RouteDashboardGetPodsBasedOnPodTypes             = "charts/dashboard/pod-types"
	RouteDashboardGetBlocksAndPodsBasedOnScales      = "charts/dashboard/scales"
	RouteDashboardGetTasksByStatus                   = "charts/dashboard/task-status"
)

View Source

const (
	RouteFavoritesGetFavorites          = "favorites"
	RouteFavoritesAddKeyAsFavorite      = "favorites/keys/%s"
	RouteFavoritesAddBlockAsFavorite    = "favorites/blocks/%s?keyId=%s"
	RouteFavoritesAddPodAsFavorite      = "favorites/pods/%s?keyId=%s"
	RouteFavoritesAddBlockPodAsFavorite = "favorites/block-pods/%s?keyId=%s&blockId=%s"
	RouteFavoritesDeleteFavorite        = "favorites/%s"
)

View Source

const (
	RouteFollowersAddUserToFollowUsList = "app/users/follow-us"
	RouteFollowersGetFollowers          = "app/followers"
)

View Source

const (
	RouteKeysGetKeys               = "keys?batchIndex=%s"
	RouteKeysAddKey                = "keys"
	RouteKeysAddKeyBasedOnTemplate = "keys/by-template?templateId=%s&excludeBlocks=%s&excludePods=%s&excludeTasks=%s"
	RouteKeysGetKey                = "keys/%s"
	RouteKeysUpdateKey             = "keys/%s"
	RouteKeysGetArchivedKeys       = "keys/archived"
	RouteKeysGetKeysLinkedToPod    = "pods/%s/linked-to/keys?keyId=%s"
	RouteKeysGetKeysLinkedToBlock  = "blocks/%s/linked-to/keys?keyId=%s"
	RouteKeysGetKeysFilteredByType = "keys/filtered/by-type?keyType=%s"
	RouteKeysBulkArchiveKeys       = "keys/archive?keyIds=%s"
	RouteKeysArchiveKey            = "keys/%s/archive"
	RouteKeysUnarchiveKey          = "keys/%s/unarchive"
	RouteKeysUpdateKeyDescription  = "keys/%s/description"
)

View Source

const (
	RouteKeysGetBlocksAndPodsAssociatedWithKey           = "charts/keys/%s/blocks-pods"
	RouteKeysGetFilteredUserKeysBlocksAndPodsForGivenKey = "charts/keys/%s/filters"
	RouteKeysGetBlockTypesAndBlocksBasedOnThemInKey      = "charts/keys/%s/block-types"
	RouteKeysGetPodsBasedOnPodTypesInKey                 = "charts/keys/%s/pod-types"
	RouteKeysGetScalesAlongWithBlocksAndPodsBasedOnThem  = "charts/keys/%s/scales"
	RouteKeysGetLinkedResources                          = "charts/keys/%s/linked-resources"
	RouteKeysGetKeyPodAndBlockScaleValues                = "charts/keys/%s/scales/%s/scale-values"
	RouteKeysGetTaskStatus                               = "charts/keys/%s/task-status"
)

View Source

const (
	RouteKeysGetKeyChecklists         = "keys/%s/checklists"
	RouteKeysAddKeyChecklist          = "keys/%s/checklists"
	RouteKeysReorderKeyChecklists     = "keys/%s/checklists/reorder"
	RouteKeysDeleteKeyChecklist       = "keys/%s/checklists/%s"
	RouteKeysRenameKeyChecklist       = "keys/%s/checklists/%s"
	RouteKeysAddKeyChecklistItem      = "keys/%s/checklists/%s/checklist-items"
	RouteKeysUpdateKeyChecklistItem   = "keys/%s/checklists/%s/checklist-items/%s"
	RouteKeysDeleteKeyChecklistItem   = "keys/%s/checklists/%s/checklist-items/%s"
	RouteKeysReorderKeyChecklistItems = "keys/%s/checklists/%s/checklist-items/reorder"
)

View Source

const (
	RouteKeysGetKeyNotes   = "keys/%s/notes"
	RouteKeysAddKeyNote    = "keys/%s/notes"
	RouteKeysUpdateKeyNote = "key-notes/%s?keyId=%s"
	RouteKeysDeleteKeyNote = "key-notes/%s?keyId=%s"
)

View Source

const (
	RouteKeysGetKeyTasks     = "keys/%s/tasks"
	RouteKeysAddKeyTask      = "keys/%s/tasks"
	RouteKeysUpdateKeyTask   = "key-tasks/%s?keyId=%s"
	RouteKeysDeleteKeyTask   = "key-tasks/%s?keyId=%s"
	RouteKeysReorderKeyTasks = "keys/%s/tasks/reorder"
)

View Source

const (
	RouteKeyPodsGetKeyPods                             = "keys/%s/pods?batchIndex=%s"
	RouteKeyPodsAddKeyPod                              = "keys/%s/pods"
	RouteKeyPodsAddKeyPodBasedOnTemplate               = "keys/%s/pods/by-template?templateId=%s&excludeTasks=%s"
	RouteKeyPodsGetKeyPodsAvailableToBeLinkedToThisKey = "keys/%s/pods/available-to-link"
	RouteKeyPodsLinkKeyPodToKey                        = "keys/%s/pods/%s/link"
	RouteKeyPodsUnlinkKeyPodFromKey                    = "keys/%s/pods/%s/unlink"
	RouteKeyPodsGetKeyPod                              = "pods/%s?keyId=%s"
	RouteKeyPodsUpdateKeyPod                           = "pods/%s?keyId=%s"
	RouteKeyPodsUpdateKeyPodCompletionStatus           = "pods/%s/by-completion-status?keyId=%s"
	RouteKeyPodsUpdateKeyPodScaleValue                 = "pods/%s/scale-value?keyId=%s"
	RouteKeyPodsAddPodTypeToKeyPod                     = "pods/%s/pod-types/%s?keyId=%s"
	RouteKeyPodsDeletePodTypeFromKeyPod                = "pods/%s/pod-types?keyId=%s"
	RouteKeyPodsAddScaleToKeyPod                       = "pods/%s/scales/%s?keyId=%s"
	RouteKeyPodsDeleteScaleFromKeyPod                  = "pods/%s/scales?keyId=%s"
	RouteKeyPodsArchiveKeyPod                          = "pods/%s/archive?keyId=%s"
	RouteKeyPodsGetArchivedKeyPods                     = "pods/archived?keyId=%s&batchIndex=%s"
	RouteKeyPodsUnarchiveKeyPod                        = "pods/%s/unarchive?keyId=%s"
	RouteKeyPodsBulkArchiveKeyPods                     = "pods/archive?keyId=%s"
	RouteKeyPodsUpdateKeyPodDescription                = "pods/%s/description?keyId=%s"
	RouteKeyPodsAllowArchivalOfKeyPod                  = "pods/%s/allow-archival?keyId=%s"
	RouteKeyPodsCopyKeyPod                             = "pods/%s/copy?keyId=%s&allTasks=%s&allChecklists=%s&targetKeyId=%s&targetBlockId=%s"
	RouteKeyPodsMoveKeyPod                             = "pods/%s/move?keyId=%s&targetKeyId=%s&targetBlockId=%s"
)

View Source

const (
	RouteKeyPodsGetKeyPodAttachments   = "pods/%s/attachments?keyId=%s"
	RouteKeyPodsAddKeyPodAttachment    = "pods/%s/attachments?keyId=%s"
	RouteKeyPodsRenameKeyPodAttachment = "key-pod-attachments/%s/rename?keyId=%s&podId=%s"
	RouteKeyPodsDeleteKeyPodAttachment = "key-pod-attachments/%s?keyId=%s&podId=%s"
)

View Source

const (
	RouteKeyPodsGetKeyPodChecklists         = "pods/%s/checklists?keyId=%s"
	RouteKeyPodsAddKeyPodChecklist          = "pods/%s/checklists?keyId=%s"
	RouteKeyPodsReorderKeyPodChecklists     = "pods/%s/checklists/reorder?keyId=%s"
	RouteKeyPodsDeleteKeyPodChecklist       = "pods/%s/checklists/%s?keyId=%s"
	RouteKeyPodsRenameKeyPodChecklist       = "pods/%s/checklists/%s?keyId=%s"
	RouteKeyPodsAddKeyPodChecklistItem      = "pods/%s/checklists/%s/checklist-items?keyId=%s"
	RouteKeyPodsUpdateKeyPodChecklistItem   = "pods/%s/checklists/%s/checklist-items/%s?keyId=%s"
	RouteKeyPodsDeleteKeyPodChecklistItem   = "pods/%s/checklists/%s/checklist-items/%s?keyId=%s"
	RouteKeyPodsReorderKeyPodChecklistItems = "pods/%s/checklists/%s/checklist-items/reorder?keyId=%s"
)

View Source

const (
	RouteKeyPodsGetKeyPodComments   = "pods/%s/comments?keyId=%s"
	RouteKeyPodsAddKeyPodComment    = "pods/%s/comments?keyId=%s"
	RouteKeyPodsUpdateKeyPodComment = "pod-comments/%s?keyId=%s&podId=%s"
	RouteKeyPodsDeleteKeyPodComment = "pod-comments/%s?keyId=%s&podId=%s"
)

View Source

const (
	RouteKeyPodsGetKeyPodNotes   = "pods/%s/notes?keyId=%s"
	RouteKeyPodsAddKeyPodNote    = "pods/%s/notes?keyId=%s"
	RouteKeyPodsUpdateKeyPodNote = "pod-notes/%s?keyId=%s&podId=%s"
	RouteKeyPodsDeleteKeyPodNote = "pod-notes/%s?keyId=%s&podId=%s"
)

View Source

const (
	RouteKeyPodsGetKeyPodTasks     = "pods/%s/tasks?keyId=%s"
	RouteKeyPodsAddKeyPodTask      = "pods/%s/tasks?keyId=%s"
	RouteKeyPodsUpdateKeyPodTask   = "pod-tasks/%s?keyId=%s&podId=%s"
	RouteKeyPodsDeleteKeyPodTask   = "pod-tasks/%s?keyId=%s&podId=%s"
	RouteKeyPodsAssignKeyPodTask   = "pod-tasks/%s/assign?keyId=%s&podId=%s"
	RouteKeyPodsUnassignKeyPodTask = "pod-tasks/%s/unassign?keyId=%s&podId=%s"
	RouteKeyPodsReorderKeyPodTasks = "pods/%s/tasks/reorder?keyId=%s"
)

View Source

const (
	RouteNotificationsGetNotifications              = "notifications"
	RouteNotificationsGetUnreadNotifications        = "notifications/unread"
	RouteNotificationsGetUnreadNotificationCount    = "notifications/unread/count"
	RouteNotificationsMarkNotificationAsRead        = "notifications/%s/read"
	RouteNotificationsMarkNotificationsAsReadInBulk = "notifications/read"
)

View Source

const (
	RoutePodTypesGetPodTypes         = "pod-types?includeCounts=%s"
	RoutePodTypesAddPodType          = "pod-types"
	RoutePodTypesUpdatePodType       = "pod-types/%s"
	RoutePodTypesDeletePodType       = "pod-types/%s"
	RoutePodTypesGetPodsUsingPodType = "pod-types/%s/pods"
)

View Source

const (
	RouteProfileGetUsersProfile               = "profiles"
	RouteProfileUpdateUsersProfile            = "profiles"
	RouteProfileUpdateUsername                = "profiles/username/%s"
	RouteProfileBlocksUserFromSendingMessages = "users/%s/block"
	RouteProfileUnblocksUser                  = "users/%s/unblock"
)

View Source

const (
	RouteProjectKeysAddAProjectPod               = "blocks/%s/project-pods?keyId=%s&projectListId=%s"
	RouteProjectKeysAddProjectPodBasedOnTemplate = "blocks/%s/project-pods/by-template?keyId=%s&projectListId=%s&templateId=%s&excludeTasks=%s"
	RouteProjectKeysLinkProjectPodToBlock        = "blocks/%s/project-pods/%s/link?keyId=%s&projectListId=%s"
	RouteProjectKeysReorderProjectPods           = "blocks/%s/project-pods/reorder?keyId=%s"
	RouteProjectKeysCopyProjectPod               = "project-pods/%s/copy?keyId=%s&blockId=%s&targetKeyId=%s&targetBlockId=%s&targetProjectListId=%s"
	RouteProjectKeysMoveProjectPod               = "project-pods/%s/move?keyId=%s&blockId=%s&targetKeyId=%s&targetBlockId=%s&targetProjectListId=%s"
	RouteProjectKeysCopyProjectBlock             = "blocks/%s/project-pods/copy?keyId=%s&targetKeyId=%s&allPods=%s&allTasks=%s"
	RouteProjectKeysAssignProjectPod             = "project-pods/%s/assign?keyId=%s&blockId=%s"
	RouteProjectKeysUnassignProjectPod           = "project-pods/%s/unassign?keyId=%s&blockId=%s"
)

View Source

const (
	RouteProjectKeysAddProjectBlockList       = "blocks/%s/project-block-lists?keyId=%s"
	RouteProjectKeysGetProjectLists           = "blocks/%s/project-block-lists?keyId=%s"
	RouteProjectKeysCopyPodsInProjectList     = "" /* 134-byte string literal not displayed */
	RouteProjectKeysBulkCopyPodsInProjectList = "" /* 129-byte string literal not displayed */
	RouteProjectKeysMovePodsInProjectList     = "project-block-lists/%s/pods/move-all?keyId=%s&blockId=%s&targetKeyId=%s&targetBlockId=%s&targetProjectListId=%s&allPods=%s"
	RouteProjectKeysBulkMovePodsInProjectList = "project-block-lists/%s/pods/move?keyId=%s&blockId=%s&targetKeyId=%s&targetBlockId=%s&targetProjectListId=%s&podIds=%s"
	RouteProjectKeysMoveProjectList           = "blocks/%s/project-block-lists/%s/move?keyId=%s&targetKeyId=%s&targetBlockId=%s&targetPosition=%s"
	RouteProjectKeysGetProjectList            = "blocks/%s/project-block-lists/%s?keyId=%s"
	RouteProjectKeysRenameProjectList         = "blocks/%s/project-block-lists/%s?keyId=%s"
	RouteProjectKeysReorderProjectList        = "blocks/%s/project-block-lists/reorder?keyId=%s"
	RouteProjectKeysArchiveProjectList        = "blocks/%s/project-block-lists/%s/archive?keyId=%s"
)

View Source

const (
	RouteRegistrationRegisterNewUserByEmail = "app/users/sign-up"
	RouteRegistrationSignInByEmail          = "app/users/sign-in"
	RouteRegistrationResetPassword          = "app/users/reset-password"
	RouteRegistrationActivateUser           = "app/user-verified/%s"
)

View Source

const (
	RouteRelationsGetRelationsForKeyMatchingSearchToken      = "search/relations?token=%s&currentKeyId=%s"
	RouteRelationsGetRelationsForBlockMatchingSearchToken    = "search/relations?token=%s&currentBlockId=%s"
	RouteRelationsGetRelationsForPodMatchingSearchToken      = "search/relations?token=%s&currentPodId=%s&keyId=%s"
	RouteRelationsGetRelationsForBlockPodMatchingSearchToken = "search/relations?token=%s&currentPodId=%s&keyId=%s&blockId=%s"

	RouteRelationsRelateBlockPodToKey          = "keys/%s/pods/%s/relate?targetKeyId=%s&targetBlockId=%s"
	RouteRelationsUnrelateBlockPodFromKey      = "keys/%s/pods/%s/unrelate?targetKeyId=%s&targetBlockId=%s"
	RouteRelationsRelateBlockPodToBlock        = "blocks/%s/pods/%s/relate?targetKeyId=%s&targetBlockId=%s"
	RouteRelationsUnrelateBlockPodFromBlock    = "blocks/%s/pods/%s/unrelate?targetKeyId=%s&targetBlockId=%s"
	RouteRelationsRelatePodToBlockPod          = "pods/%s/pods/%s/relate?sourceKeyId=%s&targetKeyId=%s&targetBlockId=%s"
	RouteRelationsUnrelatePodFromBlockPod      = "pods/%s/pods/%s/unrelate?sourceKeyId=%s&targetKeyId=%s&targetBlockId=%s"
	RouteRelationsRelateBlockPodToBlockPod     = "pods/%s/pods/%s/relate?sourceKeyId=%s&sourceBlockId=%s&targetKeyId=%s&targetBlockId=%s"
	RouteRelationsUnrelateBlockPodFromBlockPod = "pods/%s/pods/%s/unrelate?sourceKeyId=%s&sourceBlockId=%s&targetKeyId=%s&targetBlockId=%s"
)

TODO(Anish,3,03/23/23): As the endpoint is same for key pod & block pod. We need to create these constants to support both with the same endpoint with different query string params.

View Source

const (
	RouteRelationsGetRelationsForKey      = "keys/%s/relations"
	RouteRelationsGetRelationsForBlock    = "blocks/%s/relations?keyId=%s"
	RouteRelationsGetRelationsForPod      = "pods/%s/relations?keyId=%s"
	RouteRelationsGetRelationsForBlockPod = "block-pods/%s/relations?keyId=%s&blockId=%s"
	RouteRelationsRelateKeyToKey          = "keys/%s/keys/%s/relate"
	RouteRelationsUnrelateKeyFromKey      = "keys/%s/keys/%s/unrelate"
	RouteRelationsRelateBlockToKey        = "keys/%s/blocks/%s/relate"
	RouteRelationsUnrelateBlockFromKey    = "keys/%s/blocks/%s/unrelate"
	RouteRelationsRelatePodToKey          = "keys/%s/pods/%s/relate?targetKeyId=%s"
	RouteRelationsUnrelatePodFromKey      = "keys/%s/pods/%s/unrelate?targetKeyId=%s"
	RouteRelationsRelatePodToBlock        = "blocks/%s/pods/%s/relate?targetKeyId=%s"
	RouteRelationsUnrelatePodFromBlock    = "blocks/%s/pods/%s/unrelate?targetKeyId=%s"
	RouteRelationsRelateBlockToBlock      = "blocks/%s/blocks/%s/relate"
	RouteRelationsUnrelateBlockFromBlock  = "blocks/%s/blocks/%s/unrelate"
	RouteRelationsRelatePodToPod          = "pods/%s/pods/%s/relate?sourceKeyId=%s&targetKeyId=%s"
	RouteRelationsUnrelatePodFromPod      = "pods/%s/pods/%s/unrelate?sourceKeyId=%s&targetKeyId=%s"
)

View Source

const (
	RouteScalesGetScales           = "scales?includeCounts=%s&excludeEmpty=%s"
	RouteScalesAddScale            = "scales"
	RouteScalesGetScale            = "scales/%s"
	RouteScalesUpdateScale         = "scales/%s"
	RouteScalesDeleteScale         = "scales/%s"
	RouteScalesGetBlocksUsingScale = "scales/%s/blocks"
	RouteScalesGetPodsUsingScale   = "scales/%s/pods"
)

View Source

const (
	RouteSchedulerGetEventsInGivenWindow = "scheduler/all-events?startDate=%s&endDate=%s"
	RouteSchedulerGetEventsForGivenDay   = "scheduler/all-events/by-start-date?startDate=%s"
	RouteSchedulerGetStandaloneEvents    = "scheduler/standalone-events"
	RouteSchedulerAddStandaloneEvent     = "scheduler/standalone-events"
	RouteSchedulerUpdateStandaloneEvent  = "scheduler/standalone-events/%s"
	RouteSchedulerDeleteStandaloneEvent  = "scheduler/standalone-events/%s"
)

View Source

const (
	RouteSearchSearchKeyBlockOrPodByToken = "search?token=%s"
	RouteSearchSearchUserByToken          = "search/users?token=%s"
)

View Source

const (
	RouteTeacherKeysGetAttachmentSubmissionsAsStudent = "classroom-pods/%s/submissions/attachments/as-student?keyId=%s&blockId=%s"
	RouteTeacherKeysGetCommentSubmissionsAsStudent    = "classroom-pods/%s/submissions/comments/as-student?keyId=%s&blockId=%s"
	RouteTeacherKeysGetStudentsInABlock               = "classroom-blocks/%s/students?keyId=%s"
)

View Source

const (
	RouteTeacherKeysGetStudentAttachmentSubmissionsAsTeacher  = "classroom-pods/%s/submissions/attachments/as-teacher?studentId=%s&keyId=%s&blockId=%s"
	RouteTeacherKeysGetStudentCommentSubmissionsAsTeacher     = "classroom-pods/%s/submissions/comments/as-teacher?studentId=%s&keyId=%s&blockId=%s"
	RouteTeacherKeysAddAttachmentToTeacherPodAsTeacher        = "classroom-pods/%s/attachments/as-teacher?keyId=%s&blockId=%s"
	RouteTeacherKeysAddCommentToTeacherPodAsTeacher           = "classroom-pods/%s/comments/as-teacher?keyId=%s&blockId=%s"
	RouteTeacherKeysGetBlockAndPodsGradesForAStudentAsTeacher = "classroom-blocks/%s/student-grades/as-teacher?studentUserId=%s&keyId=%s"
	RouteTeacherKeysPublishStudentGradesForABlock             = "classroom-blocks/%s/student-grades/publish?keyId=%s"
	RouteTeacherKeysBulkPublishPodGradesForAStudent           = "classroom-pods/students/%s/grades/publish?keyId=%s&blockId=%s"
	RouteTeacherKeysBulkPublishPodGradesForStudents           = "classroom-pods/%s/students/grades/publish?keyId=%s&blockId=%s"
	RouteTeacherKeysGetBlockGradesForStudents                 = "classroom-blocks/%s/students/grades?keyId=%s"
	RouteTeacherKeysGetPodGradesForStudents                   = "classroom-pods/%s/students/grades?keyId=%s&blockId=%s"
	RouteTeacherKeysAssignGradeToStudent                      = "classroom-blocks/%s/student/grade?studentUserId=%s&keyId=%s"
	RouteTeacherKeysAssignPodGradeForAStudentAsTeacher        = "classroom-pods/%s/student/grade?studentUserId=%s&keyId=%s&blockId=%s"
	RouteTeacherKeysGetStudentProfile                         = "classroom/students/%s/profile?keyId=%s&blockId=%s"
)

View Source

const (
	RouteTemplatesGetKeyTemplates   = "templates/keys"
	RouteTemplatesGetBlockTemplates = "templates/blocks"
	RouteTemplatesGetPodTemplates   = "templates/pods"
)

View Source

const (
	RouteUserGetUsers              = "users"
	RouteUserGetUserByUuid         = "users/uuid/%s"
	RouteUserGetUserByEmail        = "users/email/%s"
	RouteUserDeactivateUserAccount = "users/deactivate-account"
)

View Source

const (
	RouteVersionGetLatestVersion = "app/latest-version"
	RouteVersionGetAppStatus     = "app/status"
)

View Source

const (
	DefaultEmail = "api_default@gmail.com"
	ActiveUser   = "api_active_user@gmail.com"
	ReadUser     = "api_read_user@gmail.com"
	WriteUser    = "api_write_user@yopmail.com"
	AdminUser    = "api_admin_user@gmail.com"
)

View Source

const (
	ReadAcl  = "read"
	WriteAcl = "write"
	AdminAcl = "admin"
)

View Source

const (
	CustomKeyType  = "CustomKey"
	TeacherKeyType = "TeacherKey"
	StudentKeyType = "StudentKey"
	ProjectKeyType = "ProjectKey"
)

View Source

const (
	AlphabeticScaleType = "Alphabetic"
	NumericScaleType    = "Numeric"
)

View Source

const GatewayHost = "https://gateway.snowpal.com/"

View Source

const Password = "Welcome1!"

View Source

const (
	RouteCommentsGetRecentComments = "comments"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
endpoints
attributes
block_pods/block_pods.1
block_pods/block_pods.2.attachments
block_pods/block_pods.3.charts
block_pods/block_pods.4.checklists
block_pods/block_pods.5.comments
block_pods/block_pods.6.notes
block_pods/block_pods.7.tasks
block_types
blocks/blocks.1
blocks/blocks.2.attachments
blocks/blocks.3.charts
blocks/blocks.4.checklists
blocks/blocks.5.comments
blocks/blocks.6.notes
blocks/blocks.7.tasks
collaboration/collaboration.1.blocks
collaboration/collaboration.2.block_pods
collaboration/collaboration.3.key_pods
comments
conversations
dashboard/dashboard.1
dashboard/dashboard.2
favorites
followers
key_pods/key_pods.1
key_pods/key_pods.2.attachments
key_pods/key_pods.3.checklists
key_pods/key_pods.4.comments
key_pods/key_pods.5.notes
key_pods/key_pods.6.tasks
keys/keys.1
keys/keys.2.charts
keys/keys.3.checklists
keys/keys.4.notes
keys/keys.5.tasks
notifications
pod_types
profile
project_keys/project_keys.1
project_keys/project_keys.2.lists
registration
relations
scales
scheduler
search
teacher_keys/teacher_keys.1.students
teacher_keys/teacher_keys.2.teachers
templates
user
version
helpers
recipes
recipes
structs
common
request
response

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL