Documentation
¶
Overview ¶
Package user provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func NewDeleteV1BookmarksBookmarkIdRequest(server string, bookmarkId string) (*http.Request, error)
- func NewDeleteV1CollectionsCollectionIdBookmarksBookmarkIdRequest(server string, collectionId string, bookmarkId string) (*http.Request, error)
- func NewDeleteV1CollectionsCollectionIdRequest(server string, collectionId string) (*http.Request, error)
- func NewDeleteV1CommentsCommentIdRequest(server string, commentId string) (*http.Request, error)
- func NewDeleteV1GoalsIdRequest(server string, id string, params *DeleteV1GoalsIdParams) (*http.Request, error)
- func NewDeleteV1NotesNoteIdRequest(server string, noteId string) (*http.Request, error)
- func NewDeleteV1PostsPostIdRequest(server string, postId string) (*http.Request, error)
- func NewGetV1ActivityDaysEstimateReadingTimeRequest(server string, params *GetV1ActivityDaysEstimateReadingTimeParams) (*http.Request, error)
- func NewGetV1ActivityDaysRequest(server string, params *GetV1ActivityDaysParams) (*http.Request, error)
- func NewGetV1BookmarksAyahsRangeRequest(server string, params *GetV1BookmarksAyahsRangeParams) (*http.Request, error)
- func NewGetV1BookmarksBookmarkRequest(server string, params *GetV1BookmarksBookmarkParams) (*http.Request, error)
- func NewGetV1BookmarksCollectionsRequest(server string, params *GetV1BookmarksCollectionsParams) (*http.Request, error)
- func NewGetV1BookmarksRequest(server string, params *GetV1BookmarksParams) (*http.Request, error)
- func NewGetV1CollectionsAllRequest(server string, params *GetV1CollectionsAllParams) (*http.Request, error)
- func NewGetV1CollectionsCollectionIdRequest(server string, collectionId string, params *GetV1CollectionsCollectionIdParams) (*http.Request, error)
- func NewGetV1CollectionsRequest(server string, params *GetV1CollectionsParams) (*http.Request, error)
- func NewGetV1GoalsEstimateRequest(server string, params *GetV1GoalsEstimateParams) (*http.Request, error)
- func NewGetV1GoalsGetTodaysPlanRequest(server string, params *GetV1GoalsGetTodaysPlanParams) (*http.Request, error)
- func NewGetV1GroupsGroupIdRequest(server string, groupId string) (*http.Request, error)
- func NewGetV1GroupsRequest(server string) (*http.Request, error)
- func NewGetV1NotesByAttachedEntityRequest(server string, params *GetV1NotesByAttachedEntityParams) (*http.Request, error)
- func NewGetV1NotesByRangeRequest(server string, params *GetV1NotesByRangeParams) (*http.Request, error)
- func NewGetV1NotesByVerseVerseKeyRequest(server string, verseKey string) (*http.Request, error)
- func NewGetV1NotesCountWithinRangeRequest(server string, params *GetV1NotesCountWithinRangeParams) (*http.Request, error)
- func NewGetV1NotesNoteIdRequest(server string, noteId string, params *GetV1NotesNoteIdParams) (*http.Request, error)
- func NewGetV1NotesRequest(server string, params *GetV1NotesParams) (*http.Request, error)
- func NewGetV1PostsPostIdCommentsRequest(server string, postId string) (*http.Request, error)
- func NewGetV1PostsPostIdRequest(server string, postId string) (*http.Request, error)
- func NewGetV1PostsRequest(server string, params *GetV1PostsParams) (*http.Request, error)
- func NewGetV1PreferencesRequest(server string) (*http.Request, error)
- func NewGetV1ReadingSessionsRequest(server string, params *GetV1ReadingSessionsParams) (*http.Request, error)
- func NewGetV1StreaksCurrentStreakDaysRequest(server string, params *GetV1StreaksCurrentStreakDaysParams) (*http.Request, error)
- func NewGetV1StreaksRequest(server string, params *GetV1StreaksParams) (*http.Request, error)
- func NewGetV1UsersNotificationsRequest(server string) (*http.Request, error)
- func NewGetV1UsersProfileRequest(server string) (*http.Request, error)
- func NewPatchV1NotesNoteIdRequest(server string, noteId string, body PatchV1NotesNoteIdJSONRequestBody) (*http.Request, error)
- func NewPatchV1NotesNoteIdRequestWithBody(server string, noteId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1ActivityDaysRequest(server string, params *PostV1ActivityDaysParams, ...) (*http.Request, error)
- func NewPostV1ActivityDaysRequestWithBody(server string, params *PostV1ActivityDaysParams, contentType string, ...) (*http.Request, error)
- func NewPostV1BookmarksRequest(server string, body PostV1BookmarksJSONRequestBody) (*http.Request, error)
- func NewPostV1BookmarksRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1CollectionsCollectionIdBookmarksRequest(server string, collectionId string, ...) (*http.Request, error)
- func NewPostV1CollectionsCollectionIdBookmarksRequestWithBody(server string, collectionId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1CollectionsCollectionIdRequest(server string, collectionId string, ...) (*http.Request, error)
- func NewPostV1CollectionsCollectionIdRequestWithBody(server string, collectionId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1CollectionsRequest(server string, body PostV1CollectionsJSONRequestBody) (*http.Request, error)
- func NewPostV1CollectionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1CommentsRequest(server string, body PostV1CommentsJSONRequestBody) (*http.Request, error)
- func NewPostV1CommentsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1GoalsRequest(server string, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody) (*http.Request, error)
- func NewPostV1GoalsRequestWithBody(server string, params *PostV1GoalsParams, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1NotesNoteIdPublishRequest(server string, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody) (*http.Request, error)
- func NewPostV1NotesNoteIdPublishRequestWithBody(server string, noteId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1NotesRequest(server string, body PostV1NotesJSONRequestBody) (*http.Request, error)
- func NewPostV1NotesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PostsReportPostIdRequest(server string, postId string, body PostV1PostsReportPostIdJSONRequestBody) (*http.Request, error)
- func NewPostV1PostsReportPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PostsRequest(server string, body PostV1PostsJSONRequestBody) (*http.Request, error)
- func NewPostV1PostsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PostsToggleLikePostIdRequest(server string, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody) (*http.Request, error)
- func NewPostV1PostsToggleLikePostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PostsToggleSavePostIdRequest(server string, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody) (*http.Request, error)
- func NewPostV1PostsToggleSavePostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PostsViewPostIdRequest(server string, postId string, body PostV1PostsViewPostIdJSONRequestBody) (*http.Request, error)
- func NewPostV1PostsViewPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1PreferencesBulkRequest(server string, params *PostV1PreferencesBulkParams, ...) (*http.Request, error)
- func NewPostV1PreferencesBulkRequestWithBody(server string, params *PostV1PreferencesBulkParams, contentType string, ...) (*http.Request, error)
- func NewPostV1PreferencesRequest(server string, params *PostV1PreferencesParams, ...) (*http.Request, error)
- func NewPostV1PreferencesRequestWithBody(server string, params *PostV1PreferencesParams, contentType string, ...) (*http.Request, error)
- func NewPostV1ReadingSessionsRequest(server string, body PostV1ReadingSessionsJSONRequestBody) (*http.Request, error)
- func NewPostV1ReadingSessionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1UsersConfirmationEmailRequest(server string, body PostV1UsersConfirmationEmailJSONRequestBody) (*http.Request, error)
- func NewPostV1UsersConfirmationEmailRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1UsersPasswordResetEmailRequest(server string, body PostV1UsersPasswordResetEmailJSONRequestBody) (*http.Request, error)
- func NewPostV1UsersPasswordResetEmailRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1UsersUsernameRegisterAndroidDeviceRequest(server string, username string, ...) (*http.Request, error)
- func NewPostV1UsersUsernameRegisterAndroidDeviceRequestWithBody(server string, username string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostV1UsersUsernameToggleFollowRequest(server string, username string, ...) (*http.Request, error)
- func NewPostV1UsersUsernameToggleFollowRequestWithBody(server string, username string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1CommentsCommentIdRequest(server string, commentId string, body PutV1CommentsCommentIdJSONRequestBody) (*http.Request, error)
- func NewPutV1CommentsCommentIdRequestWithBody(server string, commentId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1GoalsIdRequest(server string, id string, params *PutV1GoalsIdParams, ...) (*http.Request, error)
- func NewPutV1GoalsIdRequestWithBody(server string, id string, params *PutV1GoalsIdParams, contentType string, ...) (*http.Request, error)
- func NewPutV1GroupsGroupIdAssignAsAdminRequest(server string, groupId string, ...) (*http.Request, error)
- func NewPutV1GroupsGroupIdAssignAsAdminRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1GroupsGroupIdInviteUserRequest(server string, groupId string, ...) (*http.Request, error)
- func NewPutV1GroupsGroupIdInviteUserRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1GroupsGroupIdRemoveUserRequest(server string, groupId string, ...) (*http.Request, error)
- func NewPutV1GroupsGroupIdRemoveUserRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1PostsPostIdRequest(server string, postId string, body PutV1PostsPostIdJSONRequestBody) (*http.Request, error)
- func NewPutV1PostsPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1UsersNotificationsSettingIdRequest(server string, settingId string, ...) (*http.Request, error)
- func NewPutV1UsersNotificationsSettingIdRequestWithBody(server string, settingId string, contentType string, body io.Reader) (*http.Request, error)
- func NewPutV1UsersProfileRequest(server string, body PutV1UsersProfileJSONRequestBody) (*http.Request, error)
- func NewPutV1UsersProfileRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type Author
- type Bookmark
- type Client
- func (c *Client) DeleteV1BookmarksBookmarkId(ctx context.Context, bookmarkId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteV1CollectionsCollectionId(ctx context.Context, collectionId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteV1CollectionsCollectionIdBookmarksBookmarkId(ctx context.Context, collectionId string, bookmarkId string, ...) (*http.Response, error)
- func (c *Client) DeleteV1CommentsCommentId(ctx context.Context, commentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteV1GoalsId(ctx context.Context, id string, params *DeleteV1GoalsIdParams, ...) (*http.Response, error)
- func (c *Client) DeleteV1NotesNoteId(ctx context.Context, noteId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteV1PostsPostId(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1ActivityDays(ctx context.Context, params *GetV1ActivityDaysParams, ...) (*http.Response, error)
- func (c *Client) GetV1ActivityDaysEstimateReadingTime(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, ...) (*http.Response, error)
- func (c *Client) GetV1Bookmarks(ctx context.Context, params *GetV1BookmarksParams, ...) (*http.Response, error)
- func (c *Client) GetV1BookmarksAyahsRange(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, ...) (*http.Response, error)
- func (c *Client) GetV1BookmarksBookmark(ctx context.Context, params *GetV1BookmarksBookmarkParams, ...) (*http.Response, error)
- func (c *Client) GetV1BookmarksCollections(ctx context.Context, params *GetV1BookmarksCollectionsParams, ...) (*http.Response, error)
- func (c *Client) GetV1Collections(ctx context.Context, params *GetV1CollectionsParams, ...) (*http.Response, error)
- func (c *Client) GetV1CollectionsAll(ctx context.Context, params *GetV1CollectionsAllParams, ...) (*http.Response, error)
- func (c *Client) GetV1CollectionsCollectionId(ctx context.Context, collectionId string, ...) (*http.Response, error)
- func (c *Client) GetV1GoalsEstimate(ctx context.Context, params *GetV1GoalsEstimateParams, ...) (*http.Response, error)
- func (c *Client) GetV1GoalsGetTodaysPlan(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, ...) (*http.Response, error)
- func (c *Client) GetV1Groups(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1GroupsGroupId(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1Notes(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1NotesByAttachedEntity(ctx context.Context, params *GetV1NotesByAttachedEntityParams, ...) (*http.Response, error)
- func (c *Client) GetV1NotesByRange(ctx context.Context, params *GetV1NotesByRangeParams, ...) (*http.Response, error)
- func (c *Client) GetV1NotesByVerseVerseKey(ctx context.Context, verseKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1NotesCountWithinRange(ctx context.Context, params *GetV1NotesCountWithinRangeParams, ...) (*http.Response, error)
- func (c *Client) GetV1NotesNoteId(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, ...) (*http.Response, error)
- func (c *Client) GetV1Posts(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1PostsPostId(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1PostsPostIdComments(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1Preferences(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1ReadingSessions(ctx context.Context, params *GetV1ReadingSessionsParams, ...) (*http.Response, error)
- func (c *Client) GetV1Streaks(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1StreaksCurrentStreakDays(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, ...) (*http.Response, error)
- func (c *Client) GetV1UsersNotifications(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetV1UsersProfile(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PatchV1NotesNoteId(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PatchV1NotesNoteIdWithBody(ctx context.Context, noteId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1ActivityDays(ctx context.Context, params *PostV1ActivityDaysParams, ...) (*http.Response, error)
- func (c *Client) PostV1ActivityDaysWithBody(ctx context.Context, params *PostV1ActivityDaysParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PostV1Bookmarks(ctx context.Context, body PostV1BookmarksJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1BookmarksWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1Collections(ctx context.Context, body PostV1CollectionsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1CollectionsCollectionId(ctx context.Context, collectionId string, ...) (*http.Response, error)
- func (c *Client) PostV1CollectionsCollectionIdBookmarks(ctx context.Context, collectionId string, ...) (*http.Response, error)
- func (c *Client) PostV1CollectionsCollectionIdBookmarksWithBody(ctx context.Context, collectionId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1CollectionsCollectionIdWithBody(ctx context.Context, collectionId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1CollectionsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1Comments(ctx context.Context, body PostV1CommentsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1CommentsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1Goals(ctx context.Context, params *PostV1GoalsParams, ...) (*http.Response, error)
- func (c *Client) PostV1GoalsWithBody(ctx context.Context, params *PostV1GoalsParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PostV1Notes(ctx context.Context, body PostV1NotesJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1NotesNoteIdPublish(ctx context.Context, noteId string, ...) (*http.Response, error)
- func (c *Client) PostV1NotesNoteIdPublishWithBody(ctx context.Context, noteId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1NotesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1Posts(ctx context.Context, body PostV1PostsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1PostsReportPostId(ctx context.Context, postId string, ...) (*http.Response, error)
- func (c *Client) PostV1PostsReportPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1PostsToggleLikePostId(ctx context.Context, postId string, ...) (*http.Response, error)
- func (c *Client) PostV1PostsToggleLikePostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1PostsToggleSavePostId(ctx context.Context, postId string, ...) (*http.Response, error)
- func (c *Client) PostV1PostsToggleSavePostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1PostsViewPostId(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1PostsViewPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1PostsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1Preferences(ctx context.Context, params *PostV1PreferencesParams, ...) (*http.Response, error)
- func (c *Client) PostV1PreferencesBulk(ctx context.Context, params *PostV1PreferencesBulkParams, ...) (*http.Response, error)
- func (c *Client) PostV1PreferencesBulkWithBody(ctx context.Context, params *PostV1PreferencesBulkParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PostV1PreferencesWithBody(ctx context.Context, params *PostV1PreferencesParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PostV1ReadingSessions(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1ReadingSessionsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1UsersConfirmationEmail(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1UsersConfirmationEmailWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1UsersPasswordResetEmail(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostV1UsersPasswordResetEmailWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1UsersUsernameRegisterAndroidDevice(ctx context.Context, username string, ...) (*http.Response, error)
- func (c *Client) PostV1UsersUsernameRegisterAndroidDeviceWithBody(ctx context.Context, username string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostV1UsersUsernameToggleFollow(ctx context.Context, username string, ...) (*http.Response, error)
- func (c *Client) PostV1UsersUsernameToggleFollowWithBody(ctx context.Context, username string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1CommentsCommentId(ctx context.Context, commentId string, ...) (*http.Response, error)
- func (c *Client) PutV1CommentsCommentIdWithBody(ctx context.Context, commentId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1GoalsId(ctx context.Context, id string, params *PutV1GoalsIdParams, ...) (*http.Response, error)
- func (c *Client) PutV1GoalsIdWithBody(ctx context.Context, id string, params *PutV1GoalsIdParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdAssignAsAdmin(ctx context.Context, groupId string, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdAssignAsAdminWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdInviteUser(ctx context.Context, groupId string, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdInviteUserWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdRemoveUser(ctx context.Context, groupId string, ...) (*http.Response, error)
- func (c *Client) PutV1GroupsGroupIdRemoveUserWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1PostsPostId(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PutV1PostsPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1UsersNotificationsSettingId(ctx context.Context, settingId string, ...) (*http.Response, error)
- func (c *Client) PutV1UsersNotificationsSettingIdWithBody(ctx context.Context, settingId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PutV1UsersProfile(ctx context.Context, body PutV1UsersProfileJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PutV1UsersProfileWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) DeleteV1BookmarksBookmarkIdWithResponse(ctx context.Context, bookmarkId string, reqEditors ...RequestEditorFn) (*DeleteV1BookmarksBookmarkIdResponse, error)
- func (c *ClientWithResponses) DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse(ctx context.Context, collectionId string, bookmarkId string, ...) (*DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse, error)
- func (c *ClientWithResponses) DeleteV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, reqEditors ...RequestEditorFn) (*DeleteV1CollectionsCollectionIdResponse, error)
- func (c *ClientWithResponses) DeleteV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, reqEditors ...RequestEditorFn) (*DeleteV1CommentsCommentIdResponse, error)
- func (c *ClientWithResponses) DeleteV1GoalsIdWithResponse(ctx context.Context, id string, params *DeleteV1GoalsIdParams, ...) (*DeleteV1GoalsIdResponse, error)
- func (c *ClientWithResponses) DeleteV1NotesNoteIdWithResponse(ctx context.Context, noteId string, reqEditors ...RequestEditorFn) (*DeleteV1NotesNoteIdResponse, error)
- func (c *ClientWithResponses) DeleteV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*DeleteV1PostsPostIdResponse, error)
- func (c *ClientWithResponses) GetV1ActivityDaysEstimateReadingTimeWithResponse(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, ...) (*GetV1ActivityDaysEstimateReadingTimeResponse, error)
- func (c *ClientWithResponses) GetV1ActivityDaysWithResponse(ctx context.Context, params *GetV1ActivityDaysParams, ...) (*GetV1ActivityDaysResponse, error)
- func (c *ClientWithResponses) GetV1BookmarksAyahsRangeWithResponse(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, ...) (*GetV1BookmarksAyahsRangeResponse, error)
- func (c *ClientWithResponses) GetV1BookmarksBookmarkWithResponse(ctx context.Context, params *GetV1BookmarksBookmarkParams, ...) (*GetV1BookmarksBookmarkResponse, error)
- func (c *ClientWithResponses) GetV1BookmarksCollectionsWithResponse(ctx context.Context, params *GetV1BookmarksCollectionsParams, ...) (*GetV1BookmarksCollectionsResponse, error)
- func (c *ClientWithResponses) GetV1BookmarksWithResponse(ctx context.Context, params *GetV1BookmarksParams, ...) (*GetV1BookmarksResponse, error)
- func (c *ClientWithResponses) GetV1CollectionsAllWithResponse(ctx context.Context, params *GetV1CollectionsAllParams, ...) (*GetV1CollectionsAllResponse, error)
- func (c *ClientWithResponses) GetV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, ...) (*GetV1CollectionsCollectionIdResponse, error)
- func (c *ClientWithResponses) GetV1CollectionsWithResponse(ctx context.Context, params *GetV1CollectionsParams, ...) (*GetV1CollectionsResponse, error)
- func (c *ClientWithResponses) GetV1GoalsEstimateWithResponse(ctx context.Context, params *GetV1GoalsEstimateParams, ...) (*GetV1GoalsEstimateResponse, error)
- func (c *ClientWithResponses) GetV1GoalsGetTodaysPlanWithResponse(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, ...) (*GetV1GoalsGetTodaysPlanResponse, error)
- func (c *ClientWithResponses) GetV1GroupsGroupIdWithResponse(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*GetV1GroupsGroupIdResponse, error)
- func (c *ClientWithResponses) GetV1GroupsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1GroupsResponse, error)
- func (c *ClientWithResponses) GetV1NotesByAttachedEntityWithResponse(ctx context.Context, params *GetV1NotesByAttachedEntityParams, ...) (*GetV1NotesByAttachedEntityResponse, error)
- func (c *ClientWithResponses) GetV1NotesByRangeWithResponse(ctx context.Context, params *GetV1NotesByRangeParams, ...) (*GetV1NotesByRangeResponse, error)
- func (c *ClientWithResponses) GetV1NotesByVerseVerseKeyWithResponse(ctx context.Context, verseKey string, reqEditors ...RequestEditorFn) (*GetV1NotesByVerseVerseKeyResponse, error)
- func (c *ClientWithResponses) GetV1NotesCountWithinRangeWithResponse(ctx context.Context, params *GetV1NotesCountWithinRangeParams, ...) (*GetV1NotesCountWithinRangeResponse, error)
- func (c *ClientWithResponses) GetV1NotesNoteIdWithResponse(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, ...) (*GetV1NotesNoteIdResponse, error)
- func (c *ClientWithResponses) GetV1NotesWithResponse(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*GetV1NotesResponse, error)
- func (c *ClientWithResponses) GetV1PostsPostIdCommentsWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdCommentsResponse, error)
- func (c *ClientWithResponses) GetV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdResponse, error)
- func (c *ClientWithResponses) GetV1PostsWithResponse(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*GetV1PostsResponse, error)
- func (c *ClientWithResponses) GetV1PreferencesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1PreferencesResponse, error)
- func (c *ClientWithResponses) GetV1ReadingSessionsWithResponse(ctx context.Context, params *GetV1ReadingSessionsParams, ...) (*GetV1ReadingSessionsResponse, error)
- func (c *ClientWithResponses) GetV1StreaksCurrentStreakDaysWithResponse(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, ...) (*GetV1StreaksCurrentStreakDaysResponse, error)
- func (c *ClientWithResponses) GetV1StreaksWithResponse(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*GetV1StreaksResponse, error)
- func (c *ClientWithResponses) GetV1UsersNotificationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersNotificationsResponse, error)
- func (c *ClientWithResponses) GetV1UsersProfileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersProfileResponse, error)
- func (c *ClientWithResponses) PatchV1NotesNoteIdWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, ...) (*PatchV1NotesNoteIdResponse, error)
- func (c *ClientWithResponses) PatchV1NotesNoteIdWithResponse(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, ...) (*PatchV1NotesNoteIdResponse, error)
- func (c *ClientWithResponses) PostV1ActivityDaysWithBodyWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, contentType string, ...) (*PostV1ActivityDaysResponse, error)
- func (c *ClientWithResponses) PostV1ActivityDaysWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, ...) (*PostV1ActivityDaysResponse, error)
- func (c *ClientWithResponses) PostV1BookmarksWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1BookmarksResponse, error)
- func (c *ClientWithResponses) PostV1BookmarksWithResponse(ctx context.Context, body PostV1BookmarksJSONRequestBody, ...) (*PostV1BookmarksResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, ...) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithResponse(ctx context.Context, collectionId string, ...) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsCollectionIdWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, ...) (*PostV1CollectionsCollectionIdResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, ...) (*PostV1CollectionsCollectionIdResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1CollectionsResponse, error)
- func (c *ClientWithResponses) PostV1CollectionsWithResponse(ctx context.Context, body PostV1CollectionsJSONRequestBody, ...) (*PostV1CollectionsResponse, error)
- func (c *ClientWithResponses) PostV1CommentsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1CommentsResponse, error)
- func (c *ClientWithResponses) PostV1CommentsWithResponse(ctx context.Context, body PostV1CommentsJSONRequestBody, ...) (*PostV1CommentsResponse, error)
- func (c *ClientWithResponses) PostV1GoalsWithBodyWithResponse(ctx context.Context, params *PostV1GoalsParams, contentType string, ...) (*PostV1GoalsResponse, error)
- func (c *ClientWithResponses) PostV1GoalsWithResponse(ctx context.Context, params *PostV1GoalsParams, ...) (*PostV1GoalsResponse, error)
- func (c *ClientWithResponses) PostV1NotesNoteIdPublishWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, ...) (*PostV1NotesNoteIdPublishResponse, error)
- func (c *ClientWithResponses) PostV1NotesNoteIdPublishWithResponse(ctx context.Context, noteId string, ...) (*PostV1NotesNoteIdPublishResponse, error)
- func (c *ClientWithResponses) PostV1NotesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1NotesResponse, error)
- func (c *ClientWithResponses) PostV1NotesWithResponse(ctx context.Context, body PostV1NotesJSONRequestBody, ...) (*PostV1NotesResponse, error)
- func (c *ClientWithResponses) PostV1PostsReportPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*PostV1PostsReportPostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsReportPostIdWithResponse(ctx context.Context, postId string, ...) (*PostV1PostsReportPostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsToggleLikePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*PostV1PostsToggleLikePostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsToggleLikePostIdWithResponse(ctx context.Context, postId string, ...) (*PostV1PostsToggleLikePostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsToggleSavePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*PostV1PostsToggleSavePostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsToggleSavePostIdWithResponse(ctx context.Context, postId string, ...) (*PostV1PostsToggleSavePostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsViewPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*PostV1PostsViewPostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsViewPostIdWithResponse(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, ...) (*PostV1PostsViewPostIdResponse, error)
- func (c *ClientWithResponses) PostV1PostsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1PostsResponse, error)
- func (c *ClientWithResponses) PostV1PostsWithResponse(ctx context.Context, body PostV1PostsJSONRequestBody, ...) (*PostV1PostsResponse, error)
- func (c *ClientWithResponses) PostV1PreferencesBulkWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, contentType string, ...) (*PostV1PreferencesBulkResponse, error)
- func (c *ClientWithResponses) PostV1PreferencesBulkWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, ...) (*PostV1PreferencesBulkResponse, error)
- func (c *ClientWithResponses) PostV1PreferencesWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesParams, contentType string, ...) (*PostV1PreferencesResponse, error)
- func (c *ClientWithResponses) PostV1PreferencesWithResponse(ctx context.Context, params *PostV1PreferencesParams, ...) (*PostV1PreferencesResponse, error)
- func (c *ClientWithResponses) PostV1ReadingSessionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1ReadingSessionsResponse, error)
- func (c *ClientWithResponses) PostV1ReadingSessionsWithResponse(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, ...) (*PostV1ReadingSessionsResponse, error)
- func (c *ClientWithResponses) PostV1UsersConfirmationEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1UsersConfirmationEmailResponse, error)
- func (c *ClientWithResponses) PostV1UsersConfirmationEmailWithResponse(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, ...) (*PostV1UsersConfirmationEmailResponse, error)
- func (c *ClientWithResponses) PostV1UsersPasswordResetEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostV1UsersPasswordResetEmailResponse, error)
- func (c *ClientWithResponses) PostV1UsersPasswordResetEmailWithResponse(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, ...) (*PostV1UsersPasswordResetEmailResponse, error)
- func (c *ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, ...) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
- func (c *ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithResponse(ctx context.Context, username string, ...) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
- func (c *ClientWithResponses) PostV1UsersUsernameToggleFollowWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, ...) (*PostV1UsersUsernameToggleFollowResponse, error)
- func (c *ClientWithResponses) PostV1UsersUsernameToggleFollowWithResponse(ctx context.Context, username string, ...) (*PostV1UsersUsernameToggleFollowResponse, error)
- func (c *ClientWithResponses) PutV1CommentsCommentIdWithBodyWithResponse(ctx context.Context, commentId string, contentType string, body io.Reader, ...) (*PutV1CommentsCommentIdResponse, error)
- func (c *ClientWithResponses) PutV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, ...) (*PutV1CommentsCommentIdResponse, error)
- func (c *ClientWithResponses) PutV1GoalsIdWithBodyWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, contentType string, ...) (*PutV1GoalsIdResponse, error)
- func (c *ClientWithResponses) PutV1GoalsIdWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, ...) (*PutV1GoalsIdResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithResponse(ctx context.Context, groupId string, ...) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdInviteUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*PutV1GroupsGroupIdInviteUserResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdInviteUserWithResponse(ctx context.Context, groupId string, ...) (*PutV1GroupsGroupIdInviteUserResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, ...) (*PutV1GroupsGroupIdRemoveUserResponse, error)
- func (c *ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithResponse(ctx context.Context, groupId string, ...) (*PutV1GroupsGroupIdRemoveUserResponse, error)
- func (c *ClientWithResponses) PutV1PostsPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, ...) (*PutV1PostsPostIdResponse, error)
- func (c *ClientWithResponses) PutV1PostsPostIdWithResponse(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, ...) (*PutV1PostsPostIdResponse, error)
- func (c *ClientWithResponses) PutV1UsersNotificationsSettingIdWithBodyWithResponse(ctx context.Context, settingId string, contentType string, body io.Reader, ...) (*PutV1UsersNotificationsSettingIdResponse, error)
- func (c *ClientWithResponses) PutV1UsersNotificationsSettingIdWithResponse(ctx context.Context, settingId string, ...) (*PutV1UsersNotificationsSettingIdResponse, error)
- func (c *ClientWithResponses) PutV1UsersProfileWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PutV1UsersProfileResponse, error)
- func (c *ClientWithResponses) PutV1UsersProfileWithResponse(ctx context.Context, body PutV1UsersProfileJSONRequestBody, ...) (*PutV1UsersProfileResponse, error)
- type ClientWithResponsesInterface
- type Collection
- type Comment
- type DeleteV1BookmarksBookmarkIdResponse
- type DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse
- type DeleteV1CollectionsCollectionIdResponse
- type DeleteV1CommentsCommentIdResponse
- type DeleteV1GoalsIdParams
- type DeleteV1GoalsIdParamsCategory
- type DeleteV1GoalsIdResponse
- type DeleteV1NotesNoteIdResponse
- type DeleteV1PostsPostIdResponse
- type EstimatedGoalTimeline
- type EstimatedGoalTimelineDay
- type EstimatedGoalTimelineDayAmount0
- type EstimatedGoalTimelineDayAmount1
- type EstimatedGoalTimelineDay_Amount
- func (t EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount0() (EstimatedGoalTimelineDayAmount0, error)
- func (t EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount1() (EstimatedGoalTimelineDayAmount1, error)
- func (t *EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount0(v EstimatedGoalTimelineDayAmount0) error
- func (t *EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount1(v EstimatedGoalTimelineDayAmount1) error
- func (t EstimatedGoalTimelineDay_Amount) MarshalJSON() ([]byte, error)
- func (t *EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount0(v EstimatedGoalTimelineDayAmount0) error
- func (t *EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount1(v EstimatedGoalTimelineDayAmount1) error
- func (t *EstimatedGoalTimelineDay_Amount) UnmarshalJSON(b []byte) error
- type GetV1ActivityDays200DataDailyTargetPages0
- type GetV1ActivityDays200DataDailyTargetRanges0
- type GetV1ActivityDays200DataDailyTargetSeconds0
- type GetV1ActivityDays200DataManuallyAddedSeconds0
- type GetV1ActivityDays200DataMushafId
- type GetV1ActivityDays200DataPagesRead0
- type GetV1ActivityDays200DataRanges0
- type GetV1ActivityDays200DataRemainingDailyTargetRanges0
- type GetV1ActivityDays200DataSecondsRead0
- type GetV1ActivityDays200DataType
- type GetV1ActivityDays200DataVersesRead0
- type GetV1ActivityDaysEstimateReadingTimeParams
- type GetV1ActivityDaysEstimateReadingTimeResponse
- type GetV1ActivityDaysParams
- type GetV1ActivityDaysParamsDateOrderBy
- type GetV1ActivityDaysParamsType
- type GetV1ActivityDaysResponse
- type GetV1ActivityDays_200_Data_DailyTargetPages
- type GetV1ActivityDays_200_Data_DailyTargetRanges
- type GetV1ActivityDays_200_Data_DailyTargetSeconds
- type GetV1ActivityDays_200_Data_ManuallyAddedSeconds
- type GetV1ActivityDays_200_Data_PagesRead
- type GetV1ActivityDays_200_Data_Ranges
- type GetV1ActivityDays_200_Data_RemainingDailyTargetRanges
- type GetV1ActivityDays_200_Data_SecondsRead
- type GetV1ActivityDays_200_Data_VersesRead
- type GetV1BookmarksAyahsRangeParams
- type GetV1BookmarksAyahsRangeParamsMushafId
- type GetV1BookmarksAyahsRangeResponse
- type GetV1BookmarksBookmarkParams
- type GetV1BookmarksBookmarkParamsMushaf
- type GetV1BookmarksBookmarkParamsType
- type GetV1BookmarksBookmarkResponse
- type GetV1BookmarksCollectionsParams
- type GetV1BookmarksCollectionsParamsMushafId
- type GetV1BookmarksCollectionsParamsType
- type GetV1BookmarksCollectionsResponse
- type GetV1BookmarksParams
- type GetV1BookmarksParamsMushafId
- type GetV1BookmarksParamsType
- type GetV1BookmarksResponse
- type GetV1CollectionsAllParams
- type GetV1CollectionsAllParamsSortBy
- type GetV1CollectionsAllResponse
- type GetV1CollectionsCollectionIdParams
- type GetV1CollectionsCollectionIdParamsSortBy
- type GetV1CollectionsCollectionIdResponse
- type GetV1CollectionsParams
- type GetV1CollectionsParamsSortBy
- type GetV1CollectionsResponse
- type GetV1GoalsEstimateParams
- type GetV1GoalsEstimateParamsAmount0
- type GetV1GoalsEstimateParamsAmount1
- type GetV1GoalsEstimateParamsMushafId
- type GetV1GoalsEstimateParamsType
- type GetV1GoalsEstimateResponse
- type GetV1GoalsGetTodaysPlan200Data0
- type GetV1GoalsGetTodaysPlan200Data0DailyTargetPages0
- type GetV1GoalsGetTodaysPlan200Data0DailyTargetRanges0
- type GetV1GoalsGetTodaysPlan200Data0DailyTargetSeconds0
- type GetV1GoalsGetTodaysPlan200Data0ManuallyAddedSeconds0
- type GetV1GoalsGetTodaysPlan200Data0MushafId
- type GetV1GoalsGetTodaysPlan200Data0PagesRead0
- type GetV1GoalsGetTodaysPlan200Data0Ranges0
- type GetV1GoalsGetTodaysPlan200Data0RemainingDailyTargetRanges0
- type GetV1GoalsGetTodaysPlan200Data0SecondsRead0
- type GetV1GoalsGetTodaysPlan200Data0Type
- type GetV1GoalsGetTodaysPlan200Data0VersesRead0
- type GetV1GoalsGetTodaysPlanParams
- type GetV1GoalsGetTodaysPlanParamsType
- type GetV1GoalsGetTodaysPlanResponse
- type GetV1GoalsGetTodaysPlan_200_Data
- type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetPages
- type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetRanges
- type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetSeconds
- type GetV1GoalsGetTodaysPlan_200_Data_0_ManuallyAddedSeconds
- type GetV1GoalsGetTodaysPlan_200_Data_0_PagesRead
- type GetV1GoalsGetTodaysPlan_200_Data_0_Ranges
- type GetV1GoalsGetTodaysPlan_200_Data_0_RemainingDailyTargetRanges
- type GetV1GoalsGetTodaysPlan_200_Data_0_SecondsRead
- type GetV1GoalsGetTodaysPlan_200_Data_0_VersesRead
- type GetV1GroupsGroupIdResponse
- type GetV1GroupsResponse
- type GetV1Notes200DataAttachedEntitiesEntityType
- type GetV1NotesByAttachedEntity200DataAttachedEntitiesEntityType
- type GetV1NotesByAttachedEntityParams
- type GetV1NotesByAttachedEntityParamsEntityType
- type GetV1NotesByAttachedEntityResponse
- type GetV1NotesByRange200DataAttachedEntitiesEntityType
- type GetV1NotesByRangeParams
- type GetV1NotesByRangeResponse
- type GetV1NotesByVerseVerseKey200DataAttachedEntitiesEntityType
- type GetV1NotesByVerseVerseKeyResponse
- type GetV1NotesCountWithinRangeParams
- type GetV1NotesCountWithinRangeResponse
- type GetV1NotesNoteId200DataAttachedEntitiesEntityType
- type GetV1NotesNoteIdParams
- type GetV1NotesNoteIdResponse
- type GetV1NotesParams
- type GetV1NotesParamsSortBy
- type GetV1NotesResponse
- type GetV1PostsParams
- type GetV1PostsParamsFiltersReferencesOperation
- type GetV1PostsParamsFiltersTagsOperation
- type GetV1PostsParamsTab
- type GetV1PostsPostIdCommentsResponse
- type GetV1PostsPostIdResponse
- type GetV1PostsResponse
- type GetV1PreferencesResponse
- type GetV1ReadingSessionsParams
- type GetV1ReadingSessionsResponse
- type GetV1Streaks200DataStatus
- type GetV1StreaksCurrentStreakDaysParams
- type GetV1StreaksCurrentStreakDaysParamsType
- type GetV1StreaksCurrentStreakDaysResponse
- type GetV1StreaksParams
- type GetV1StreaksParamsOrderBy
- type GetV1StreaksParamsSortOrder
- type GetV1StreaksParamsStatus
- type GetV1StreaksParamsType
- type GetV1StreaksResponse
- type GetV1UsersNotificationsResponse
- type GetV1UsersProfileResponse
- type HttpRequestDoer
- type Notification
- type NotificationSettings
- type PatchV1NotesNoteId200DataAttachedEntitiesEntityType
- type PatchV1NotesNoteIdJSONBody
- type PatchV1NotesNoteIdJSONRequestBody
- type PatchV1NotesNoteIdResponse
- type Post
- type PostReference
- type PostTag
- type PostV1ActivityDaysJSONBody
- type PostV1ActivityDaysJSONBody0
- type PostV1ActivityDaysJSONBody0MushafId
- type PostV1ActivityDaysJSONBodyType
- type PostV1ActivityDaysJSONRequestBody
- type PostV1ActivityDaysParams
- type PostV1ActivityDaysResponse
- type PostV1BookmarksJSONBody
- type PostV1BookmarksJSONBody0
- type PostV1BookmarksJSONBody0Mushaf
- type PostV1BookmarksJSONBody0Type
- type PostV1BookmarksJSONBody1
- type PostV1BookmarksJSONBody1Mushaf
- type PostV1BookmarksJSONBody1Type
- type PostV1BookmarksJSONRequestBody
- type PostV1BookmarksResponse
- type PostV1CollectionsCollectionIdBookmarksJSONBody
- type PostV1CollectionsCollectionIdBookmarksJSONBody0
- type PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf
- type PostV1CollectionsCollectionIdBookmarksJSONBody0Type
- type PostV1CollectionsCollectionIdBookmarksJSONBody1
- type PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf
- type PostV1CollectionsCollectionIdBookmarksJSONBody1Type
- type PostV1CollectionsCollectionIdBookmarksJSONRequestBody
- type PostV1CollectionsCollectionIdBookmarksResponse
- type PostV1CollectionsCollectionIdJSONBody
- type PostV1CollectionsCollectionIdJSONRequestBody
- type PostV1CollectionsCollectionIdResponse
- type PostV1CollectionsJSONBody
- type PostV1CollectionsJSONRequestBody
- type PostV1CollectionsResponse
- type PostV1CommentsJSONBody
- type PostV1CommentsJSONBody0
- type PostV1CommentsJSONRequestBody
- type PostV1CommentsResponse
- type PostV1GoalsJSONBody
- type PostV1GoalsJSONBodyAmount0
- type PostV1GoalsJSONBodyAmount1
- type PostV1GoalsJSONBodyCategory
- type PostV1GoalsJSONBodyType
- type PostV1GoalsJSONBody_Amount
- type PostV1GoalsJSONRequestBody
- type PostV1GoalsParams
- type PostV1GoalsParamsMushafId
- type PostV1GoalsResponse
- type PostV1Notes200DataAttachedEntitiesEntityType
- type PostV1NotesJSONBody
- type PostV1NotesJSONBodyAttachedEntityEntityType
- type PostV1NotesJSONRequestBody
- type PostV1NotesNoteIdPublishJSONBody
- type PostV1NotesNoteIdPublishJSONRequestBody
- type PostV1NotesNoteIdPublishResponse
- type PostV1NotesResponse
- type PostV1PostsJSONBody
- type PostV1PostsJSONBody0
- type PostV1PostsJSONRequestBody
- type PostV1PostsReportPostIdJSONBody
- type PostV1PostsReportPostIdJSONBodyAbuse
- type PostV1PostsReportPostIdJSONRequestBody
- type PostV1PostsReportPostIdResponse
- type PostV1PostsResponse
- type PostV1PostsToggleLikePostIdJSONBody
- type PostV1PostsToggleLikePostIdJSONRequestBody
- type PostV1PostsToggleLikePostIdResponse
- type PostV1PostsToggleSavePostIdJSONBody
- type PostV1PostsToggleSavePostIdJSONRequestBody
- type PostV1PostsToggleSavePostIdResponse
- type PostV1PostsViewPostIdJSONBody
- type PostV1PostsViewPostIdJSONRequestBody
- type PostV1PostsViewPostIdResponse
- type PostV1PreferencesBulkJSONRequestBody
- type PostV1PreferencesBulkParams
- type PostV1PreferencesBulkParamsMushafId
- type PostV1PreferencesBulkResponse
- type PostV1PreferencesJSONBody
- type PostV1PreferencesJSONBody0
- type PostV1PreferencesJSONBody0Key
- type PostV1PreferencesJSONBody1
- type PostV1PreferencesJSONBody10
- type PostV1PreferencesJSONBody10Value
- type PostV1PreferencesJSONBody11
- type PostV1PreferencesJSONBody11Value
- type PostV1PreferencesJSONBody12
- type PostV1PreferencesJSONBody13
- type PostV1PreferencesJSONBody13Value
- type PostV1PreferencesJSONBody14
- type PostV1PreferencesJSONBody14Value
- type PostV1PreferencesJSONBody15
- type PostV1PreferencesJSONBody15Value
- type PostV1PreferencesJSONBody16
- type PostV1PreferencesJSONBody16Value
- type PostV1PreferencesJSONBody17
- type PostV1PreferencesJSONBody18
- type PostV1PreferencesJSONBody19
- type PostV1PreferencesJSONBody1Key
- type PostV1PreferencesJSONBody2
- type PostV1PreferencesJSONBody20
- type PostV1PreferencesJSONBody21
- type PostV1PreferencesJSONBody21Value
- type PostV1PreferencesJSONBody2Key
- type PostV1PreferencesJSONBody3
- type PostV1PreferencesJSONBody3Key
- type PostV1PreferencesJSONBody4
- type PostV1PreferencesJSONBody4Key
- type PostV1PreferencesJSONBody5
- type PostV1PreferencesJSONBody5Key
- type PostV1PreferencesJSONBody6
- type PostV1PreferencesJSONBody6Key
- type PostV1PreferencesJSONBody7
- type PostV1PreferencesJSONBody7Value
- type PostV1PreferencesJSONBody8
- type PostV1PreferencesJSONBody8Value
- type PostV1PreferencesJSONBody9
- type PostV1PreferencesJSONBody9Value
- type PostV1PreferencesJSONBodyGroup
- type PostV1PreferencesJSONRequestBody
- type PostV1PreferencesParams
- type PostV1PreferencesParamsMushafId
- type PostV1PreferencesResponse
- type PostV1ReadingSessionsJSONBody
- type PostV1ReadingSessionsJSONRequestBody
- type PostV1ReadingSessionsResponse
- type PostV1UsersConfirmationEmailJSONBody
- type PostV1UsersConfirmationEmailJSONRequestBody
- type PostV1UsersConfirmationEmailResponse
- type PostV1UsersPasswordResetEmailJSONBody
- type PostV1UsersPasswordResetEmailJSONRequestBody
- type PostV1UsersPasswordResetEmailResponse
- type PostV1UsersUsernameRegisterAndroidDeviceJSONBody
- type PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody
- type PostV1UsersUsernameRegisterAndroidDeviceResponse
- type PostV1UsersUsernameToggleFollowJSONBody
- type PostV1UsersUsernameToggleFollowJSONRequestBody
- type PostV1UsersUsernameToggleFollowResponse
- type Preference
- type PreferenceAudioPlaybackRate
- type PreferenceLanguageLanguage
- type PreferenceQuranReaderStylesMushafLines
- type PreferenceQuranReaderStylesQuranFont
- type PreferenceReadingReadingPreference
- type PreferenceReadingSelectedWordByWordLocale
- type PreferenceReadingWordByWordContentType
- type PreferenceReadingWordByWordDisplay
- type PreferenceReadingWordClickFunctionality
- type PreferenceThemeType
- type PutV1CommentsCommentIdJSONBody
- type PutV1CommentsCommentIdJSONRequestBody
- type PutV1CommentsCommentIdResponse
- type PutV1GoalsIdJSONBody
- type PutV1GoalsIdJSONBodyAmount0
- type PutV1GoalsIdJSONBodyAmount1
- type PutV1GoalsIdJSONBodyCategory
- type PutV1GoalsIdJSONBodyType
- type PutV1GoalsIdJSONBody_Amount
- type PutV1GoalsIdJSONRequestBody
- type PutV1GoalsIdParams
- type PutV1GoalsIdParamsMushafId
- type PutV1GoalsIdResponse
- type PutV1GroupsGroupIdAssignAsAdminJSONBody
- type PutV1GroupsGroupIdAssignAsAdminJSONRequestBody
- type PutV1GroupsGroupIdAssignAsAdminResponse
- type PutV1GroupsGroupIdInviteUserJSONBody
- type PutV1GroupsGroupIdInviteUserJSONRequestBody
- type PutV1GroupsGroupIdInviteUserResponse
- type PutV1GroupsGroupIdRemoveUserJSONBody
- type PutV1GroupsGroupIdRemoveUserJSONRequestBody
- type PutV1GroupsGroupIdRemoveUserResponse
- type PutV1PostsPostIdJSONBody
- type PutV1PostsPostIdJSONRequestBody
- type PutV1PostsPostIdResponse
- type PutV1UsersNotificationsSettingIdJSONRequestBody
- type PutV1UsersNotificationsSettingIdResponse
- type PutV1UsersProfileJSONBody
- type PutV1UsersProfileJSONRequestBody
- type PutV1UsersProfileResponse
- type ReadingSession
- type RequestEditorFn
- type Room
- type RoomPostStatus
- type RoomRoomType
- type UserProfile
Constants ¶
const ( X_auth_tokenScopes = "x_auth_token.Scopes" X_client_idScopes = "x_client_id.Scopes" )
const ServerUrlPreProductionServer = "https://apis-prelive.quran.foundation/auth"
ServerUrlPreProductionServer defines the Server URL for Pre-production Server
const ServerUrlProductionServer = "https://apis.quran.foundation/auth"
ServerUrlProductionServer defines the Server URL for Production Server
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func NewDeleteV1BookmarksBookmarkIdRequest ¶
NewDeleteV1BookmarksBookmarkIdRequest generates requests for DeleteV1BookmarksBookmarkId
func NewDeleteV1CollectionsCollectionIdBookmarksBookmarkIdRequest ¶
func NewDeleteV1CollectionsCollectionIdBookmarksBookmarkIdRequest(server string, collectionId string, bookmarkId string) (*http.Request, error)
NewDeleteV1CollectionsCollectionIdBookmarksBookmarkIdRequest generates requests for DeleteV1CollectionsCollectionIdBookmarksBookmarkId
func NewDeleteV1CollectionsCollectionIdRequest ¶
func NewDeleteV1CollectionsCollectionIdRequest(server string, collectionId string) (*http.Request, error)
NewDeleteV1CollectionsCollectionIdRequest generates requests for DeleteV1CollectionsCollectionId
func NewDeleteV1CommentsCommentIdRequest ¶
NewDeleteV1CommentsCommentIdRequest generates requests for DeleteV1CommentsCommentId
func NewDeleteV1GoalsIdRequest ¶
func NewDeleteV1GoalsIdRequest(server string, id string, params *DeleteV1GoalsIdParams) (*http.Request, error)
NewDeleteV1GoalsIdRequest generates requests for DeleteV1GoalsId
func NewDeleteV1NotesNoteIdRequest ¶
NewDeleteV1NotesNoteIdRequest generates requests for DeleteV1NotesNoteId
func NewDeleteV1PostsPostIdRequest ¶
NewDeleteV1PostsPostIdRequest generates requests for DeleteV1PostsPostId
func NewGetV1ActivityDaysEstimateReadingTimeRequest ¶
func NewGetV1ActivityDaysEstimateReadingTimeRequest(server string, params *GetV1ActivityDaysEstimateReadingTimeParams) (*http.Request, error)
NewGetV1ActivityDaysEstimateReadingTimeRequest generates requests for GetV1ActivityDaysEstimateReadingTime
func NewGetV1ActivityDaysRequest ¶
func NewGetV1ActivityDaysRequest(server string, params *GetV1ActivityDaysParams) (*http.Request, error)
NewGetV1ActivityDaysRequest generates requests for GetV1ActivityDays
func NewGetV1BookmarksAyahsRangeRequest ¶
func NewGetV1BookmarksAyahsRangeRequest(server string, params *GetV1BookmarksAyahsRangeParams) (*http.Request, error)
NewGetV1BookmarksAyahsRangeRequest generates requests for GetV1BookmarksAyahsRange
func NewGetV1BookmarksBookmarkRequest ¶
func NewGetV1BookmarksBookmarkRequest(server string, params *GetV1BookmarksBookmarkParams) (*http.Request, error)
NewGetV1BookmarksBookmarkRequest generates requests for GetV1BookmarksBookmark
func NewGetV1BookmarksCollectionsRequest ¶
func NewGetV1BookmarksCollectionsRequest(server string, params *GetV1BookmarksCollectionsParams) (*http.Request, error)
NewGetV1BookmarksCollectionsRequest generates requests for GetV1BookmarksCollections
func NewGetV1BookmarksRequest ¶
func NewGetV1BookmarksRequest(server string, params *GetV1BookmarksParams) (*http.Request, error)
NewGetV1BookmarksRequest generates requests for GetV1Bookmarks
func NewGetV1CollectionsAllRequest ¶
func NewGetV1CollectionsAllRequest(server string, params *GetV1CollectionsAllParams) (*http.Request, error)
NewGetV1CollectionsAllRequest generates requests for GetV1CollectionsAll
func NewGetV1CollectionsCollectionIdRequest ¶
func NewGetV1CollectionsCollectionIdRequest(server string, collectionId string, params *GetV1CollectionsCollectionIdParams) (*http.Request, error)
NewGetV1CollectionsCollectionIdRequest generates requests for GetV1CollectionsCollectionId
func NewGetV1CollectionsRequest ¶
func NewGetV1CollectionsRequest(server string, params *GetV1CollectionsParams) (*http.Request, error)
NewGetV1CollectionsRequest generates requests for GetV1Collections
func NewGetV1GoalsEstimateRequest ¶
func NewGetV1GoalsEstimateRequest(server string, params *GetV1GoalsEstimateParams) (*http.Request, error)
NewGetV1GoalsEstimateRequest generates requests for GetV1GoalsEstimate
func NewGetV1GoalsGetTodaysPlanRequest ¶
func NewGetV1GoalsGetTodaysPlanRequest(server string, params *GetV1GoalsGetTodaysPlanParams) (*http.Request, error)
NewGetV1GoalsGetTodaysPlanRequest generates requests for GetV1GoalsGetTodaysPlan
func NewGetV1GroupsGroupIdRequest ¶
NewGetV1GroupsGroupIdRequest generates requests for GetV1GroupsGroupId
func NewGetV1GroupsRequest ¶
NewGetV1GroupsRequest generates requests for GetV1Groups
func NewGetV1NotesByAttachedEntityRequest ¶
func NewGetV1NotesByAttachedEntityRequest(server string, params *GetV1NotesByAttachedEntityParams) (*http.Request, error)
NewGetV1NotesByAttachedEntityRequest generates requests for GetV1NotesByAttachedEntity
func NewGetV1NotesByRangeRequest ¶
func NewGetV1NotesByRangeRequest(server string, params *GetV1NotesByRangeParams) (*http.Request, error)
NewGetV1NotesByRangeRequest generates requests for GetV1NotesByRange
func NewGetV1NotesByVerseVerseKeyRequest ¶
NewGetV1NotesByVerseVerseKeyRequest generates requests for GetV1NotesByVerseVerseKey
func NewGetV1NotesCountWithinRangeRequest ¶
func NewGetV1NotesCountWithinRangeRequest(server string, params *GetV1NotesCountWithinRangeParams) (*http.Request, error)
NewGetV1NotesCountWithinRangeRequest generates requests for GetV1NotesCountWithinRange
func NewGetV1NotesNoteIdRequest ¶
func NewGetV1NotesNoteIdRequest(server string, noteId string, params *GetV1NotesNoteIdParams) (*http.Request, error)
NewGetV1NotesNoteIdRequest generates requests for GetV1NotesNoteId
func NewGetV1NotesRequest ¶
func NewGetV1NotesRequest(server string, params *GetV1NotesParams) (*http.Request, error)
NewGetV1NotesRequest generates requests for GetV1Notes
func NewGetV1PostsPostIdCommentsRequest ¶
NewGetV1PostsPostIdCommentsRequest generates requests for GetV1PostsPostIdComments
func NewGetV1PostsPostIdRequest ¶
NewGetV1PostsPostIdRequest generates requests for GetV1PostsPostId
func NewGetV1PostsRequest ¶
func NewGetV1PostsRequest(server string, params *GetV1PostsParams) (*http.Request, error)
NewGetV1PostsRequest generates requests for GetV1Posts
func NewGetV1PreferencesRequest ¶
NewGetV1PreferencesRequest generates requests for GetV1Preferences
func NewGetV1ReadingSessionsRequest ¶
func NewGetV1ReadingSessionsRequest(server string, params *GetV1ReadingSessionsParams) (*http.Request, error)
NewGetV1ReadingSessionsRequest generates requests for GetV1ReadingSessions
func NewGetV1StreaksCurrentStreakDaysRequest ¶
func NewGetV1StreaksCurrentStreakDaysRequest(server string, params *GetV1StreaksCurrentStreakDaysParams) (*http.Request, error)
NewGetV1StreaksCurrentStreakDaysRequest generates requests for GetV1StreaksCurrentStreakDays
func NewGetV1StreaksRequest ¶
func NewGetV1StreaksRequest(server string, params *GetV1StreaksParams) (*http.Request, error)
NewGetV1StreaksRequest generates requests for GetV1Streaks
func NewGetV1UsersNotificationsRequest ¶
NewGetV1UsersNotificationsRequest generates requests for GetV1UsersNotifications
func NewGetV1UsersProfileRequest ¶
NewGetV1UsersProfileRequest generates requests for GetV1UsersProfile
func NewPatchV1NotesNoteIdRequest ¶
func NewPatchV1NotesNoteIdRequest(server string, noteId string, body PatchV1NotesNoteIdJSONRequestBody) (*http.Request, error)
NewPatchV1NotesNoteIdRequest calls the generic PatchV1NotesNoteId builder with application/json body
func NewPatchV1NotesNoteIdRequestWithBody ¶
func NewPatchV1NotesNoteIdRequestWithBody(server string, noteId string, contentType string, body io.Reader) (*http.Request, error)
NewPatchV1NotesNoteIdRequestWithBody generates requests for PatchV1NotesNoteId with any type of body
func NewPostV1ActivityDaysRequest ¶
func NewPostV1ActivityDaysRequest(server string, params *PostV1ActivityDaysParams, body PostV1ActivityDaysJSONRequestBody) (*http.Request, error)
NewPostV1ActivityDaysRequest calls the generic PostV1ActivityDays builder with application/json body
func NewPostV1ActivityDaysRequestWithBody ¶
func NewPostV1ActivityDaysRequestWithBody(server string, params *PostV1ActivityDaysParams, contentType string, body io.Reader) (*http.Request, error)
NewPostV1ActivityDaysRequestWithBody generates requests for PostV1ActivityDays with any type of body
func NewPostV1BookmarksRequest ¶
func NewPostV1BookmarksRequest(server string, body PostV1BookmarksJSONRequestBody) (*http.Request, error)
NewPostV1BookmarksRequest calls the generic PostV1Bookmarks builder with application/json body
func NewPostV1BookmarksRequestWithBody ¶
func NewPostV1BookmarksRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1BookmarksRequestWithBody generates requests for PostV1Bookmarks with any type of body
func NewPostV1CollectionsCollectionIdBookmarksRequest ¶
func NewPostV1CollectionsCollectionIdBookmarksRequest(server string, collectionId string, body PostV1CollectionsCollectionIdBookmarksJSONRequestBody) (*http.Request, error)
NewPostV1CollectionsCollectionIdBookmarksRequest calls the generic PostV1CollectionsCollectionIdBookmarks builder with application/json body
func NewPostV1CollectionsCollectionIdBookmarksRequestWithBody ¶
func NewPostV1CollectionsCollectionIdBookmarksRequestWithBody(server string, collectionId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1CollectionsCollectionIdBookmarksRequestWithBody generates requests for PostV1CollectionsCollectionIdBookmarks with any type of body
func NewPostV1CollectionsCollectionIdRequest ¶
func NewPostV1CollectionsCollectionIdRequest(server string, collectionId string, body PostV1CollectionsCollectionIdJSONRequestBody) (*http.Request, error)
NewPostV1CollectionsCollectionIdRequest calls the generic PostV1CollectionsCollectionId builder with application/json body
func NewPostV1CollectionsCollectionIdRequestWithBody ¶
func NewPostV1CollectionsCollectionIdRequestWithBody(server string, collectionId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1CollectionsCollectionIdRequestWithBody generates requests for PostV1CollectionsCollectionId with any type of body
func NewPostV1CollectionsRequest ¶
func NewPostV1CollectionsRequest(server string, body PostV1CollectionsJSONRequestBody) (*http.Request, error)
NewPostV1CollectionsRequest calls the generic PostV1Collections builder with application/json body
func NewPostV1CollectionsRequestWithBody ¶
func NewPostV1CollectionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1CollectionsRequestWithBody generates requests for PostV1Collections with any type of body
func NewPostV1CommentsRequest ¶
func NewPostV1CommentsRequest(server string, body PostV1CommentsJSONRequestBody) (*http.Request, error)
NewPostV1CommentsRequest calls the generic PostV1Comments builder with application/json body
func NewPostV1CommentsRequestWithBody ¶
func NewPostV1CommentsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1CommentsRequestWithBody generates requests for PostV1Comments with any type of body
func NewPostV1GoalsRequest ¶
func NewPostV1GoalsRequest(server string, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody) (*http.Request, error)
NewPostV1GoalsRequest calls the generic PostV1Goals builder with application/json body
func NewPostV1GoalsRequestWithBody ¶
func NewPostV1GoalsRequestWithBody(server string, params *PostV1GoalsParams, contentType string, body io.Reader) (*http.Request, error)
NewPostV1GoalsRequestWithBody generates requests for PostV1Goals with any type of body
func NewPostV1NotesNoteIdPublishRequest ¶
func NewPostV1NotesNoteIdPublishRequest(server string, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody) (*http.Request, error)
NewPostV1NotesNoteIdPublishRequest calls the generic PostV1NotesNoteIdPublish builder with application/json body
func NewPostV1NotesNoteIdPublishRequestWithBody ¶
func NewPostV1NotesNoteIdPublishRequestWithBody(server string, noteId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1NotesNoteIdPublishRequestWithBody generates requests for PostV1NotesNoteIdPublish with any type of body
func NewPostV1NotesRequest ¶
func NewPostV1NotesRequest(server string, body PostV1NotesJSONRequestBody) (*http.Request, error)
NewPostV1NotesRequest calls the generic PostV1Notes builder with application/json body
func NewPostV1NotesRequestWithBody ¶
func NewPostV1NotesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1NotesRequestWithBody generates requests for PostV1Notes with any type of body
func NewPostV1PostsReportPostIdRequest ¶
func NewPostV1PostsReportPostIdRequest(server string, postId string, body PostV1PostsReportPostIdJSONRequestBody) (*http.Request, error)
NewPostV1PostsReportPostIdRequest calls the generic PostV1PostsReportPostId builder with application/json body
func NewPostV1PostsReportPostIdRequestWithBody ¶
func NewPostV1PostsReportPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PostsReportPostIdRequestWithBody generates requests for PostV1PostsReportPostId with any type of body
func NewPostV1PostsRequest ¶
func NewPostV1PostsRequest(server string, body PostV1PostsJSONRequestBody) (*http.Request, error)
NewPostV1PostsRequest calls the generic PostV1Posts builder with application/json body
func NewPostV1PostsRequestWithBody ¶
func NewPostV1PostsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PostsRequestWithBody generates requests for PostV1Posts with any type of body
func NewPostV1PostsToggleLikePostIdRequest ¶
func NewPostV1PostsToggleLikePostIdRequest(server string, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody) (*http.Request, error)
NewPostV1PostsToggleLikePostIdRequest calls the generic PostV1PostsToggleLikePostId builder with application/json body
func NewPostV1PostsToggleLikePostIdRequestWithBody ¶
func NewPostV1PostsToggleLikePostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PostsToggleLikePostIdRequestWithBody generates requests for PostV1PostsToggleLikePostId with any type of body
func NewPostV1PostsToggleSavePostIdRequest ¶
func NewPostV1PostsToggleSavePostIdRequest(server string, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody) (*http.Request, error)
NewPostV1PostsToggleSavePostIdRequest calls the generic PostV1PostsToggleSavePostId builder with application/json body
func NewPostV1PostsToggleSavePostIdRequestWithBody ¶
func NewPostV1PostsToggleSavePostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PostsToggleSavePostIdRequestWithBody generates requests for PostV1PostsToggleSavePostId with any type of body
func NewPostV1PostsViewPostIdRequest ¶
func NewPostV1PostsViewPostIdRequest(server string, postId string, body PostV1PostsViewPostIdJSONRequestBody) (*http.Request, error)
NewPostV1PostsViewPostIdRequest calls the generic PostV1PostsViewPostId builder with application/json body
func NewPostV1PostsViewPostIdRequestWithBody ¶
func NewPostV1PostsViewPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PostsViewPostIdRequestWithBody generates requests for PostV1PostsViewPostId with any type of body
func NewPostV1PreferencesBulkRequest ¶
func NewPostV1PreferencesBulkRequest(server string, params *PostV1PreferencesBulkParams, body PostV1PreferencesBulkJSONRequestBody) (*http.Request, error)
NewPostV1PreferencesBulkRequest calls the generic PostV1PreferencesBulk builder with application/json body
func NewPostV1PreferencesBulkRequestWithBody ¶
func NewPostV1PreferencesBulkRequestWithBody(server string, params *PostV1PreferencesBulkParams, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PreferencesBulkRequestWithBody generates requests for PostV1PreferencesBulk with any type of body
func NewPostV1PreferencesRequest ¶
func NewPostV1PreferencesRequest(server string, params *PostV1PreferencesParams, body PostV1PreferencesJSONRequestBody) (*http.Request, error)
NewPostV1PreferencesRequest calls the generic PostV1Preferences builder with application/json body
func NewPostV1PreferencesRequestWithBody ¶
func NewPostV1PreferencesRequestWithBody(server string, params *PostV1PreferencesParams, contentType string, body io.Reader) (*http.Request, error)
NewPostV1PreferencesRequestWithBody generates requests for PostV1Preferences with any type of body
func NewPostV1ReadingSessionsRequest ¶
func NewPostV1ReadingSessionsRequest(server string, body PostV1ReadingSessionsJSONRequestBody) (*http.Request, error)
NewPostV1ReadingSessionsRequest calls the generic PostV1ReadingSessions builder with application/json body
func NewPostV1ReadingSessionsRequestWithBody ¶
func NewPostV1ReadingSessionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1ReadingSessionsRequestWithBody generates requests for PostV1ReadingSessions with any type of body
func NewPostV1UsersConfirmationEmailRequest ¶
func NewPostV1UsersConfirmationEmailRequest(server string, body PostV1UsersConfirmationEmailJSONRequestBody) (*http.Request, error)
NewPostV1UsersConfirmationEmailRequest calls the generic PostV1UsersConfirmationEmail builder with application/json body
func NewPostV1UsersConfirmationEmailRequestWithBody ¶
func NewPostV1UsersConfirmationEmailRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1UsersConfirmationEmailRequestWithBody generates requests for PostV1UsersConfirmationEmail with any type of body
func NewPostV1UsersPasswordResetEmailRequest ¶
func NewPostV1UsersPasswordResetEmailRequest(server string, body PostV1UsersPasswordResetEmailJSONRequestBody) (*http.Request, error)
NewPostV1UsersPasswordResetEmailRequest calls the generic PostV1UsersPasswordResetEmail builder with application/json body
func NewPostV1UsersPasswordResetEmailRequestWithBody ¶
func NewPostV1UsersPasswordResetEmailRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1UsersPasswordResetEmailRequestWithBody generates requests for PostV1UsersPasswordResetEmail with any type of body
func NewPostV1UsersUsernameRegisterAndroidDeviceRequest ¶
func NewPostV1UsersUsernameRegisterAndroidDeviceRequest(server string, username string, body PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody) (*http.Request, error)
NewPostV1UsersUsernameRegisterAndroidDeviceRequest calls the generic PostV1UsersUsernameRegisterAndroidDevice builder with application/json body
func NewPostV1UsersUsernameRegisterAndroidDeviceRequestWithBody ¶
func NewPostV1UsersUsernameRegisterAndroidDeviceRequestWithBody(server string, username string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1UsersUsernameRegisterAndroidDeviceRequestWithBody generates requests for PostV1UsersUsernameRegisterAndroidDevice with any type of body
func NewPostV1UsersUsernameToggleFollowRequest ¶
func NewPostV1UsersUsernameToggleFollowRequest(server string, username string, body PostV1UsersUsernameToggleFollowJSONRequestBody) (*http.Request, error)
NewPostV1UsersUsernameToggleFollowRequest calls the generic PostV1UsersUsernameToggleFollow builder with application/json body
func NewPostV1UsersUsernameToggleFollowRequestWithBody ¶
func NewPostV1UsersUsernameToggleFollowRequestWithBody(server string, username string, contentType string, body io.Reader) (*http.Request, error)
NewPostV1UsersUsernameToggleFollowRequestWithBody generates requests for PostV1UsersUsernameToggleFollow with any type of body
func NewPutV1CommentsCommentIdRequest ¶
func NewPutV1CommentsCommentIdRequest(server string, commentId string, body PutV1CommentsCommentIdJSONRequestBody) (*http.Request, error)
NewPutV1CommentsCommentIdRequest calls the generic PutV1CommentsCommentId builder with application/json body
func NewPutV1CommentsCommentIdRequestWithBody ¶
func NewPutV1CommentsCommentIdRequestWithBody(server string, commentId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1CommentsCommentIdRequestWithBody generates requests for PutV1CommentsCommentId with any type of body
func NewPutV1GoalsIdRequest ¶
func NewPutV1GoalsIdRequest(server string, id string, params *PutV1GoalsIdParams, body PutV1GoalsIdJSONRequestBody) (*http.Request, error)
NewPutV1GoalsIdRequest calls the generic PutV1GoalsId builder with application/json body
func NewPutV1GoalsIdRequestWithBody ¶
func NewPutV1GoalsIdRequestWithBody(server string, id string, params *PutV1GoalsIdParams, contentType string, body io.Reader) (*http.Request, error)
NewPutV1GoalsIdRequestWithBody generates requests for PutV1GoalsId with any type of body
func NewPutV1GroupsGroupIdAssignAsAdminRequest ¶
func NewPutV1GroupsGroupIdAssignAsAdminRequest(server string, groupId string, body PutV1GroupsGroupIdAssignAsAdminJSONRequestBody) (*http.Request, error)
NewPutV1GroupsGroupIdAssignAsAdminRequest calls the generic PutV1GroupsGroupIdAssignAsAdmin builder with application/json body
func NewPutV1GroupsGroupIdAssignAsAdminRequestWithBody ¶
func NewPutV1GroupsGroupIdAssignAsAdminRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1GroupsGroupIdAssignAsAdminRequestWithBody generates requests for PutV1GroupsGroupIdAssignAsAdmin with any type of body
func NewPutV1GroupsGroupIdInviteUserRequest ¶
func NewPutV1GroupsGroupIdInviteUserRequest(server string, groupId string, body PutV1GroupsGroupIdInviteUserJSONRequestBody) (*http.Request, error)
NewPutV1GroupsGroupIdInviteUserRequest calls the generic PutV1GroupsGroupIdInviteUser builder with application/json body
func NewPutV1GroupsGroupIdInviteUserRequestWithBody ¶
func NewPutV1GroupsGroupIdInviteUserRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1GroupsGroupIdInviteUserRequestWithBody generates requests for PutV1GroupsGroupIdInviteUser with any type of body
func NewPutV1GroupsGroupIdRemoveUserRequest ¶
func NewPutV1GroupsGroupIdRemoveUserRequest(server string, groupId string, body PutV1GroupsGroupIdRemoveUserJSONRequestBody) (*http.Request, error)
NewPutV1GroupsGroupIdRemoveUserRequest calls the generic PutV1GroupsGroupIdRemoveUser builder with application/json body
func NewPutV1GroupsGroupIdRemoveUserRequestWithBody ¶
func NewPutV1GroupsGroupIdRemoveUserRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1GroupsGroupIdRemoveUserRequestWithBody generates requests for PutV1GroupsGroupIdRemoveUser with any type of body
func NewPutV1PostsPostIdRequest ¶
func NewPutV1PostsPostIdRequest(server string, postId string, body PutV1PostsPostIdJSONRequestBody) (*http.Request, error)
NewPutV1PostsPostIdRequest calls the generic PutV1PostsPostId builder with application/json body
func NewPutV1PostsPostIdRequestWithBody ¶
func NewPutV1PostsPostIdRequestWithBody(server string, postId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1PostsPostIdRequestWithBody generates requests for PutV1PostsPostId with any type of body
func NewPutV1UsersNotificationsSettingIdRequest ¶
func NewPutV1UsersNotificationsSettingIdRequest(server string, settingId string, body PutV1UsersNotificationsSettingIdJSONRequestBody) (*http.Request, error)
NewPutV1UsersNotificationsSettingIdRequest calls the generic PutV1UsersNotificationsSettingId builder with application/json body
func NewPutV1UsersNotificationsSettingIdRequestWithBody ¶
func NewPutV1UsersNotificationsSettingIdRequestWithBody(server string, settingId string, contentType string, body io.Reader) (*http.Request, error)
NewPutV1UsersNotificationsSettingIdRequestWithBody generates requests for PutV1UsersNotificationsSettingId with any type of body
func NewPutV1UsersProfileRequest ¶
func NewPutV1UsersProfileRequest(server string, body PutV1UsersProfileJSONRequestBody) (*http.Request, error)
NewPutV1UsersProfileRequest calls the generic PutV1UsersProfile builder with application/json body
Types ¶
type Author ¶
type Author struct {
// DisplayName The display name of the author of the comment.
DisplayName string `json:"displayName"`
// FirstName The first name of the author of the comment.
FirstName string `json:"firstName"`
// Followed Whether the current user is following the author of the comment or not.
Followed bool `json:"followed"`
// Id The id of the author of the comment.
Id int `json:"id"`
// LastName The first name of the author of the comment.
LastName string `json:"lastName"`
// ProfileImage The profile image of the author of the comment. Will be `null` if it's empty
ProfileImage *string `json:"profileImage"`
// Username The username of the author of the comment.
Username string `json:"username"`
// Verified Whether the comment's author has been verified.
Verified bool `json:"verified"`
}
Author Details about the author.
type Bookmark ¶
type Bookmark struct {
CreatedAt time.Time `json:"createdAt"`
Group *string `json:"group,omitempty"`
Id string `json:"id"`
Key int `json:"key"`
Type string `json:"type"`
VerseNumber *int `json:"verseNumber,omitempty"`
}
Bookmark defines model for Bookmark.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) DeleteV1BookmarksBookmarkId ¶
func (*Client) DeleteV1CollectionsCollectionId ¶
func (*Client) DeleteV1CollectionsCollectionIdBookmarksBookmarkId ¶
func (*Client) DeleteV1CommentsCommentId ¶
func (*Client) DeleteV1GoalsId ¶
func (c *Client) DeleteV1GoalsId(ctx context.Context, id string, params *DeleteV1GoalsIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteV1NotesNoteId ¶
func (*Client) DeleteV1PostsPostId ¶
func (*Client) GetV1ActivityDays ¶
func (c *Client) GetV1ActivityDays(ctx context.Context, params *GetV1ActivityDaysParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1ActivityDaysEstimateReadingTime ¶
func (c *Client) GetV1ActivityDaysEstimateReadingTime(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1Bookmarks ¶
func (c *Client) GetV1Bookmarks(ctx context.Context, params *GetV1BookmarksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1BookmarksAyahsRange ¶
func (c *Client) GetV1BookmarksAyahsRange(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1BookmarksBookmark ¶
func (c *Client) GetV1BookmarksBookmark(ctx context.Context, params *GetV1BookmarksBookmarkParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1BookmarksCollections ¶
func (c *Client) GetV1BookmarksCollections(ctx context.Context, params *GetV1BookmarksCollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1Collections ¶
func (c *Client) GetV1Collections(ctx context.Context, params *GetV1CollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1CollectionsAll ¶
func (c *Client) GetV1CollectionsAll(ctx context.Context, params *GetV1CollectionsAllParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1CollectionsCollectionId ¶
func (c *Client) GetV1CollectionsCollectionId(ctx context.Context, collectionId string, params *GetV1CollectionsCollectionIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1GoalsEstimate ¶
func (c *Client) GetV1GoalsEstimate(ctx context.Context, params *GetV1GoalsEstimateParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1GoalsGetTodaysPlan ¶
func (c *Client) GetV1GoalsGetTodaysPlan(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1Groups ¶
func (*Client) GetV1GroupsGroupId ¶
func (*Client) GetV1Notes ¶
func (c *Client) GetV1Notes(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1NotesByAttachedEntity ¶
func (c *Client) GetV1NotesByAttachedEntity(ctx context.Context, params *GetV1NotesByAttachedEntityParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1NotesByRange ¶
func (c *Client) GetV1NotesByRange(ctx context.Context, params *GetV1NotesByRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1NotesByVerseVerseKey ¶
func (*Client) GetV1NotesCountWithinRange ¶
func (c *Client) GetV1NotesCountWithinRange(ctx context.Context, params *GetV1NotesCountWithinRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1NotesNoteId ¶
func (c *Client) GetV1NotesNoteId(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1Posts ¶
func (c *Client) GetV1Posts(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1PostsPostId ¶
func (*Client) GetV1PostsPostIdComments ¶
func (*Client) GetV1Preferences ¶
func (*Client) GetV1ReadingSessions ¶
func (c *Client) GetV1ReadingSessions(ctx context.Context, params *GetV1ReadingSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1Streaks ¶
func (c *Client) GetV1Streaks(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1StreaksCurrentStreakDays ¶
func (c *Client) GetV1StreaksCurrentStreakDays(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetV1UsersNotifications ¶
func (*Client) GetV1UsersProfile ¶
func (*Client) PatchV1NotesNoteId ¶
func (c *Client) PatchV1NotesNoteId(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PatchV1NotesNoteIdWithBody ¶
func (*Client) PostV1ActivityDays ¶
func (c *Client) PostV1ActivityDays(ctx context.Context, params *PostV1ActivityDaysParams, body PostV1ActivityDaysJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1ActivityDaysWithBody ¶
func (*Client) PostV1Bookmarks ¶
func (c *Client) PostV1Bookmarks(ctx context.Context, body PostV1BookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1BookmarksWithBody ¶
func (*Client) PostV1Collections ¶
func (c *Client) PostV1Collections(ctx context.Context, body PostV1CollectionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1CollectionsCollectionId ¶
func (c *Client) PostV1CollectionsCollectionId(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1CollectionsCollectionIdBookmarks ¶
func (c *Client) PostV1CollectionsCollectionIdBookmarks(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdBookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1CollectionsCollectionIdBookmarksWithBody ¶
func (*Client) PostV1CollectionsCollectionIdWithBody ¶
func (*Client) PostV1CollectionsWithBody ¶
func (*Client) PostV1Comments ¶
func (c *Client) PostV1Comments(ctx context.Context, body PostV1CommentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1CommentsWithBody ¶
func (*Client) PostV1Goals ¶
func (c *Client) PostV1Goals(ctx context.Context, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1GoalsWithBody ¶
func (*Client) PostV1Notes ¶
func (c *Client) PostV1Notes(ctx context.Context, body PostV1NotesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1NotesNoteIdPublish ¶
func (c *Client) PostV1NotesNoteIdPublish(ctx context.Context, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1NotesNoteIdPublishWithBody ¶
func (*Client) PostV1NotesWithBody ¶
func (*Client) PostV1Posts ¶
func (c *Client) PostV1Posts(ctx context.Context, body PostV1PostsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PostsReportPostId ¶
func (c *Client) PostV1PostsReportPostId(ctx context.Context, postId string, body PostV1PostsReportPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PostsReportPostIdWithBody ¶
func (*Client) PostV1PostsToggleLikePostId ¶
func (c *Client) PostV1PostsToggleLikePostId(ctx context.Context, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PostsToggleLikePostIdWithBody ¶
func (*Client) PostV1PostsToggleSavePostId ¶
func (c *Client) PostV1PostsToggleSavePostId(ctx context.Context, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PostsToggleSavePostIdWithBody ¶
func (*Client) PostV1PostsViewPostId ¶
func (c *Client) PostV1PostsViewPostId(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PostsViewPostIdWithBody ¶
func (*Client) PostV1PostsWithBody ¶
func (*Client) PostV1Preferences ¶
func (c *Client) PostV1Preferences(ctx context.Context, params *PostV1PreferencesParams, body PostV1PreferencesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PreferencesBulk ¶
func (c *Client) PostV1PreferencesBulk(ctx context.Context, params *PostV1PreferencesBulkParams, body PostV1PreferencesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1PreferencesBulkWithBody ¶
func (*Client) PostV1PreferencesWithBody ¶
func (*Client) PostV1ReadingSessions ¶
func (c *Client) PostV1ReadingSessions(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1ReadingSessionsWithBody ¶
func (*Client) PostV1UsersConfirmationEmail ¶
func (c *Client) PostV1UsersConfirmationEmail(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1UsersConfirmationEmailWithBody ¶
func (*Client) PostV1UsersPasswordResetEmail ¶
func (c *Client) PostV1UsersPasswordResetEmail(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1UsersPasswordResetEmailWithBody ¶
func (*Client) PostV1UsersUsernameRegisterAndroidDevice ¶
func (c *Client) PostV1UsersUsernameRegisterAndroidDevice(ctx context.Context, username string, body PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1UsersUsernameRegisterAndroidDeviceWithBody ¶
func (*Client) PostV1UsersUsernameToggleFollow ¶
func (c *Client) PostV1UsersUsernameToggleFollow(ctx context.Context, username string, body PostV1UsersUsernameToggleFollowJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostV1UsersUsernameToggleFollowWithBody ¶
func (*Client) PutV1CommentsCommentId ¶
func (c *Client) PutV1CommentsCommentId(ctx context.Context, commentId string, body PutV1CommentsCommentIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1CommentsCommentIdWithBody ¶
func (*Client) PutV1GoalsId ¶
func (c *Client) PutV1GoalsId(ctx context.Context, id string, params *PutV1GoalsIdParams, body PutV1GoalsIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1GoalsIdWithBody ¶
func (*Client) PutV1GroupsGroupIdAssignAsAdmin ¶
func (c *Client) PutV1GroupsGroupIdAssignAsAdmin(ctx context.Context, groupId string, body PutV1GroupsGroupIdAssignAsAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1GroupsGroupIdAssignAsAdminWithBody ¶
func (*Client) PutV1GroupsGroupIdInviteUser ¶
func (c *Client) PutV1GroupsGroupIdInviteUser(ctx context.Context, groupId string, body PutV1GroupsGroupIdInviteUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1GroupsGroupIdInviteUserWithBody ¶
func (*Client) PutV1GroupsGroupIdRemoveUser ¶
func (c *Client) PutV1GroupsGroupIdRemoveUser(ctx context.Context, groupId string, body PutV1GroupsGroupIdRemoveUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1GroupsGroupIdRemoveUserWithBody ¶
func (*Client) PutV1PostsPostId ¶
func (c *Client) PutV1PostsPostId(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1PostsPostIdWithBody ¶
func (*Client) PutV1UsersNotificationsSettingId ¶
func (c *Client) PutV1UsersNotificationsSettingId(ctx context.Context, settingId string, body PutV1UsersNotificationsSettingIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PutV1UsersNotificationsSettingIdWithBody ¶
func (*Client) PutV1UsersProfile ¶
func (c *Client) PutV1UsersProfile(ctx context.Context, body PutV1UsersProfileJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// GetV1ActivityDays request
GetV1ActivityDays(ctx context.Context, params *GetV1ActivityDaysParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1ActivityDaysWithBody request with any body
PostV1ActivityDaysWithBody(ctx context.Context, params *PostV1ActivityDaysParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1ActivityDays(ctx context.Context, params *PostV1ActivityDaysParams, body PostV1ActivityDaysJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1ActivityDaysEstimateReadingTime request
GetV1ActivityDaysEstimateReadingTime(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Bookmarks request
GetV1Bookmarks(ctx context.Context, params *GetV1BookmarksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1BookmarksWithBody request with any body
PostV1BookmarksWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Bookmarks(ctx context.Context, body PostV1BookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1BookmarksAyahsRange request
GetV1BookmarksAyahsRange(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1BookmarksBookmark request
GetV1BookmarksBookmark(ctx context.Context, params *GetV1BookmarksBookmarkParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1BookmarksCollections request
GetV1BookmarksCollections(ctx context.Context, params *GetV1BookmarksCollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1BookmarksBookmarkId request
DeleteV1BookmarksBookmarkId(ctx context.Context, bookmarkId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Collections request
GetV1Collections(ctx context.Context, params *GetV1CollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1CollectionsWithBody request with any body
PostV1CollectionsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Collections(ctx context.Context, body PostV1CollectionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1CollectionsAll request
GetV1CollectionsAll(ctx context.Context, params *GetV1CollectionsAllParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1CollectionsCollectionId request
DeleteV1CollectionsCollectionId(ctx context.Context, collectionId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1CollectionsCollectionId request
GetV1CollectionsCollectionId(ctx context.Context, collectionId string, params *GetV1CollectionsCollectionIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1CollectionsCollectionIdWithBody request with any body
PostV1CollectionsCollectionIdWithBody(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1CollectionsCollectionId(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1CollectionsCollectionIdBookmarksWithBody request with any body
PostV1CollectionsCollectionIdBookmarksWithBody(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1CollectionsCollectionIdBookmarks(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdBookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1CollectionsCollectionIdBookmarksBookmarkId request
DeleteV1CollectionsCollectionIdBookmarksBookmarkId(ctx context.Context, collectionId string, bookmarkId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1CommentsWithBody request with any body
PostV1CommentsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Comments(ctx context.Context, body PostV1CommentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1CommentsCommentId request
DeleteV1CommentsCommentId(ctx context.Context, commentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1CommentsCommentIdWithBody request with any body
PutV1CommentsCommentIdWithBody(ctx context.Context, commentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1CommentsCommentId(ctx context.Context, commentId string, body PutV1CommentsCommentIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1GoalsWithBody request with any body
PostV1GoalsWithBody(ctx context.Context, params *PostV1GoalsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Goals(ctx context.Context, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1GoalsEstimate request
GetV1GoalsEstimate(ctx context.Context, params *GetV1GoalsEstimateParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1GoalsGetTodaysPlan request
GetV1GoalsGetTodaysPlan(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1GoalsId request
DeleteV1GoalsId(ctx context.Context, id string, params *DeleteV1GoalsIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1GoalsIdWithBody request with any body
PutV1GoalsIdWithBody(ctx context.Context, id string, params *PutV1GoalsIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1GoalsId(ctx context.Context, id string, params *PutV1GoalsIdParams, body PutV1GoalsIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Groups request
GetV1Groups(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1GroupsGroupId request
GetV1GroupsGroupId(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1GroupsGroupIdAssignAsAdminWithBody request with any body
PutV1GroupsGroupIdAssignAsAdminWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1GroupsGroupIdAssignAsAdmin(ctx context.Context, groupId string, body PutV1GroupsGroupIdAssignAsAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1GroupsGroupIdInviteUserWithBody request with any body
PutV1GroupsGroupIdInviteUserWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1GroupsGroupIdInviteUser(ctx context.Context, groupId string, body PutV1GroupsGroupIdInviteUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1GroupsGroupIdRemoveUserWithBody request with any body
PutV1GroupsGroupIdRemoveUserWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1GroupsGroupIdRemoveUser(ctx context.Context, groupId string, body PutV1GroupsGroupIdRemoveUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Notes request
GetV1Notes(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1NotesWithBody request with any body
PostV1NotesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Notes(ctx context.Context, body PostV1NotesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1NotesByAttachedEntity request
GetV1NotesByAttachedEntity(ctx context.Context, params *GetV1NotesByAttachedEntityParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1NotesByRange request
GetV1NotesByRange(ctx context.Context, params *GetV1NotesByRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1NotesByVerseVerseKey request
GetV1NotesByVerseVerseKey(ctx context.Context, verseKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1NotesCountWithinRange request
GetV1NotesCountWithinRange(ctx context.Context, params *GetV1NotesCountWithinRangeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1NotesNoteId request
DeleteV1NotesNoteId(ctx context.Context, noteId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1NotesNoteId request
GetV1NotesNoteId(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchV1NotesNoteIdWithBody request with any body
PatchV1NotesNoteIdWithBody(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchV1NotesNoteId(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1NotesNoteIdPublishWithBody request with any body
PostV1NotesNoteIdPublishWithBody(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1NotesNoteIdPublish(ctx context.Context, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Posts request
GetV1Posts(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PostsWithBody request with any body
PostV1PostsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Posts(ctx context.Context, body PostV1PostsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PostsReportPostIdWithBody request with any body
PostV1PostsReportPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1PostsReportPostId(ctx context.Context, postId string, body PostV1PostsReportPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PostsToggleLikePostIdWithBody request with any body
PostV1PostsToggleLikePostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1PostsToggleLikePostId(ctx context.Context, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PostsToggleSavePostIdWithBody request with any body
PostV1PostsToggleSavePostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1PostsToggleSavePostId(ctx context.Context, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PostsViewPostIdWithBody request with any body
PostV1PostsViewPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1PostsViewPostId(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteV1PostsPostId request
DeleteV1PostsPostId(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1PostsPostId request
GetV1PostsPostId(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1PostsPostIdWithBody request with any body
PutV1PostsPostIdWithBody(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1PostsPostId(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1PostsPostIdComments request
GetV1PostsPostIdComments(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Preferences request
GetV1Preferences(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PreferencesWithBody request with any body
PostV1PreferencesWithBody(ctx context.Context, params *PostV1PreferencesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1Preferences(ctx context.Context, params *PostV1PreferencesParams, body PostV1PreferencesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1PreferencesBulkWithBody request with any body
PostV1PreferencesBulkWithBody(ctx context.Context, params *PostV1PreferencesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1PreferencesBulk(ctx context.Context, params *PostV1PreferencesBulkParams, body PostV1PreferencesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1ReadingSessions request
GetV1ReadingSessions(ctx context.Context, params *GetV1ReadingSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1ReadingSessionsWithBody request with any body
PostV1ReadingSessionsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1ReadingSessions(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1Streaks request
GetV1Streaks(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1StreaksCurrentStreakDays request
GetV1StreaksCurrentStreakDays(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1UsersConfirmationEmailWithBody request with any body
PostV1UsersConfirmationEmailWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1UsersConfirmationEmail(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1UsersNotifications request
GetV1UsersNotifications(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1UsersNotificationsSettingIdWithBody request with any body
PutV1UsersNotificationsSettingIdWithBody(ctx context.Context, settingId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1UsersNotificationsSettingId(ctx context.Context, settingId string, body PutV1UsersNotificationsSettingIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1UsersPasswordResetEmailWithBody request with any body
PostV1UsersPasswordResetEmailWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1UsersPasswordResetEmail(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetV1UsersProfile request
GetV1UsersProfile(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PutV1UsersProfileWithBody request with any body
PutV1UsersProfileWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PutV1UsersProfile(ctx context.Context, body PutV1UsersProfileJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1UsersUsernameRegisterAndroidDeviceWithBody request with any body
PostV1UsersUsernameRegisterAndroidDeviceWithBody(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1UsersUsernameRegisterAndroidDevice(ctx context.Context, username string, body PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostV1UsersUsernameToggleFollowWithBody request with any body
PostV1UsersUsernameToggleFollowWithBody(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostV1UsersUsernameToggleFollow(ctx context.Context, username string, body PostV1UsersUsernameToggleFollowJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) DeleteV1BookmarksBookmarkIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1BookmarksBookmarkIdWithResponse(ctx context.Context, bookmarkId string, reqEditors ...RequestEditorFn) (*DeleteV1BookmarksBookmarkIdResponse, error)
DeleteV1BookmarksBookmarkIdWithResponse request returning *DeleteV1BookmarksBookmarkIdResponse
func (*ClientWithResponses) DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse(ctx context.Context, collectionId string, bookmarkId string, reqEditors ...RequestEditorFn) (*DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse, error)
DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse request returning *DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse
func (*ClientWithResponses) DeleteV1CollectionsCollectionIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, reqEditors ...RequestEditorFn) (*DeleteV1CollectionsCollectionIdResponse, error)
DeleteV1CollectionsCollectionIdWithResponse request returning *DeleteV1CollectionsCollectionIdResponse
func (*ClientWithResponses) DeleteV1CommentsCommentIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, reqEditors ...RequestEditorFn) (*DeleteV1CommentsCommentIdResponse, error)
DeleteV1CommentsCommentIdWithResponse request returning *DeleteV1CommentsCommentIdResponse
func (*ClientWithResponses) DeleteV1GoalsIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1GoalsIdWithResponse(ctx context.Context, id string, params *DeleteV1GoalsIdParams, reqEditors ...RequestEditorFn) (*DeleteV1GoalsIdResponse, error)
DeleteV1GoalsIdWithResponse request returning *DeleteV1GoalsIdResponse
func (*ClientWithResponses) DeleteV1NotesNoteIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1NotesNoteIdWithResponse(ctx context.Context, noteId string, reqEditors ...RequestEditorFn) (*DeleteV1NotesNoteIdResponse, error)
DeleteV1NotesNoteIdWithResponse request returning *DeleteV1NotesNoteIdResponse
func (*ClientWithResponses) DeleteV1PostsPostIdWithResponse ¶
func (c *ClientWithResponses) DeleteV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*DeleteV1PostsPostIdResponse, error)
DeleteV1PostsPostIdWithResponse request returning *DeleteV1PostsPostIdResponse
func (*ClientWithResponses) GetV1ActivityDaysEstimateReadingTimeWithResponse ¶
func (c *ClientWithResponses) GetV1ActivityDaysEstimateReadingTimeWithResponse(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, reqEditors ...RequestEditorFn) (*GetV1ActivityDaysEstimateReadingTimeResponse, error)
GetV1ActivityDaysEstimateReadingTimeWithResponse request returning *GetV1ActivityDaysEstimateReadingTimeResponse
func (*ClientWithResponses) GetV1ActivityDaysWithResponse ¶
func (c *ClientWithResponses) GetV1ActivityDaysWithResponse(ctx context.Context, params *GetV1ActivityDaysParams, reqEditors ...RequestEditorFn) (*GetV1ActivityDaysResponse, error)
GetV1ActivityDaysWithResponse request returning *GetV1ActivityDaysResponse
func (*ClientWithResponses) GetV1BookmarksAyahsRangeWithResponse ¶
func (c *ClientWithResponses) GetV1BookmarksAyahsRangeWithResponse(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksAyahsRangeResponse, error)
GetV1BookmarksAyahsRangeWithResponse request returning *GetV1BookmarksAyahsRangeResponse
func (*ClientWithResponses) GetV1BookmarksBookmarkWithResponse ¶
func (c *ClientWithResponses) GetV1BookmarksBookmarkWithResponse(ctx context.Context, params *GetV1BookmarksBookmarkParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksBookmarkResponse, error)
GetV1BookmarksBookmarkWithResponse request returning *GetV1BookmarksBookmarkResponse
func (*ClientWithResponses) GetV1BookmarksCollectionsWithResponse ¶
func (c *ClientWithResponses) GetV1BookmarksCollectionsWithResponse(ctx context.Context, params *GetV1BookmarksCollectionsParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksCollectionsResponse, error)
GetV1BookmarksCollectionsWithResponse request returning *GetV1BookmarksCollectionsResponse
func (*ClientWithResponses) GetV1BookmarksWithResponse ¶
func (c *ClientWithResponses) GetV1BookmarksWithResponse(ctx context.Context, params *GetV1BookmarksParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksResponse, error)
GetV1BookmarksWithResponse request returning *GetV1BookmarksResponse
func (*ClientWithResponses) GetV1CollectionsAllWithResponse ¶
func (c *ClientWithResponses) GetV1CollectionsAllWithResponse(ctx context.Context, params *GetV1CollectionsAllParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsAllResponse, error)
GetV1CollectionsAllWithResponse request returning *GetV1CollectionsAllResponse
func (*ClientWithResponses) GetV1CollectionsCollectionIdWithResponse ¶
func (c *ClientWithResponses) GetV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, params *GetV1CollectionsCollectionIdParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsCollectionIdResponse, error)
GetV1CollectionsCollectionIdWithResponse request returning *GetV1CollectionsCollectionIdResponse
func (*ClientWithResponses) GetV1CollectionsWithResponse ¶
func (c *ClientWithResponses) GetV1CollectionsWithResponse(ctx context.Context, params *GetV1CollectionsParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsResponse, error)
GetV1CollectionsWithResponse request returning *GetV1CollectionsResponse
func (*ClientWithResponses) GetV1GoalsEstimateWithResponse ¶
func (c *ClientWithResponses) GetV1GoalsEstimateWithResponse(ctx context.Context, params *GetV1GoalsEstimateParams, reqEditors ...RequestEditorFn) (*GetV1GoalsEstimateResponse, error)
GetV1GoalsEstimateWithResponse request returning *GetV1GoalsEstimateResponse
func (*ClientWithResponses) GetV1GoalsGetTodaysPlanWithResponse ¶
func (c *ClientWithResponses) GetV1GoalsGetTodaysPlanWithResponse(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, reqEditors ...RequestEditorFn) (*GetV1GoalsGetTodaysPlanResponse, error)
GetV1GoalsGetTodaysPlanWithResponse request returning *GetV1GoalsGetTodaysPlanResponse
func (*ClientWithResponses) GetV1GroupsGroupIdWithResponse ¶
func (c *ClientWithResponses) GetV1GroupsGroupIdWithResponse(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*GetV1GroupsGroupIdResponse, error)
GetV1GroupsGroupIdWithResponse request returning *GetV1GroupsGroupIdResponse
func (*ClientWithResponses) GetV1GroupsWithResponse ¶
func (c *ClientWithResponses) GetV1GroupsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1GroupsResponse, error)
GetV1GroupsWithResponse request returning *GetV1GroupsResponse
func (*ClientWithResponses) GetV1NotesByAttachedEntityWithResponse ¶
func (c *ClientWithResponses) GetV1NotesByAttachedEntityWithResponse(ctx context.Context, params *GetV1NotesByAttachedEntityParams, reqEditors ...RequestEditorFn) (*GetV1NotesByAttachedEntityResponse, error)
GetV1NotesByAttachedEntityWithResponse request returning *GetV1NotesByAttachedEntityResponse
func (*ClientWithResponses) GetV1NotesByRangeWithResponse ¶
func (c *ClientWithResponses) GetV1NotesByRangeWithResponse(ctx context.Context, params *GetV1NotesByRangeParams, reqEditors ...RequestEditorFn) (*GetV1NotesByRangeResponse, error)
GetV1NotesByRangeWithResponse request returning *GetV1NotesByRangeResponse
func (*ClientWithResponses) GetV1NotesByVerseVerseKeyWithResponse ¶
func (c *ClientWithResponses) GetV1NotesByVerseVerseKeyWithResponse(ctx context.Context, verseKey string, reqEditors ...RequestEditorFn) (*GetV1NotesByVerseVerseKeyResponse, error)
GetV1NotesByVerseVerseKeyWithResponse request returning *GetV1NotesByVerseVerseKeyResponse
func (*ClientWithResponses) GetV1NotesCountWithinRangeWithResponse ¶
func (c *ClientWithResponses) GetV1NotesCountWithinRangeWithResponse(ctx context.Context, params *GetV1NotesCountWithinRangeParams, reqEditors ...RequestEditorFn) (*GetV1NotesCountWithinRangeResponse, error)
GetV1NotesCountWithinRangeWithResponse request returning *GetV1NotesCountWithinRangeResponse
func (*ClientWithResponses) GetV1NotesNoteIdWithResponse ¶
func (c *ClientWithResponses) GetV1NotesNoteIdWithResponse(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, reqEditors ...RequestEditorFn) (*GetV1NotesNoteIdResponse, error)
GetV1NotesNoteIdWithResponse request returning *GetV1NotesNoteIdResponse
func (*ClientWithResponses) GetV1NotesWithResponse ¶
func (c *ClientWithResponses) GetV1NotesWithResponse(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*GetV1NotesResponse, error)
GetV1NotesWithResponse request returning *GetV1NotesResponse
func (*ClientWithResponses) GetV1PostsPostIdCommentsWithResponse ¶
func (c *ClientWithResponses) GetV1PostsPostIdCommentsWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdCommentsResponse, error)
GetV1PostsPostIdCommentsWithResponse request returning *GetV1PostsPostIdCommentsResponse
func (*ClientWithResponses) GetV1PostsPostIdWithResponse ¶
func (c *ClientWithResponses) GetV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdResponse, error)
GetV1PostsPostIdWithResponse request returning *GetV1PostsPostIdResponse
func (*ClientWithResponses) GetV1PostsWithResponse ¶
func (c *ClientWithResponses) GetV1PostsWithResponse(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*GetV1PostsResponse, error)
GetV1PostsWithResponse request returning *GetV1PostsResponse
func (*ClientWithResponses) GetV1PreferencesWithResponse ¶
func (c *ClientWithResponses) GetV1PreferencesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1PreferencesResponse, error)
GetV1PreferencesWithResponse request returning *GetV1PreferencesResponse
func (*ClientWithResponses) GetV1ReadingSessionsWithResponse ¶
func (c *ClientWithResponses) GetV1ReadingSessionsWithResponse(ctx context.Context, params *GetV1ReadingSessionsParams, reqEditors ...RequestEditorFn) (*GetV1ReadingSessionsResponse, error)
GetV1ReadingSessionsWithResponse request returning *GetV1ReadingSessionsResponse
func (*ClientWithResponses) GetV1StreaksCurrentStreakDaysWithResponse ¶
func (c *ClientWithResponses) GetV1StreaksCurrentStreakDaysWithResponse(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, reqEditors ...RequestEditorFn) (*GetV1StreaksCurrentStreakDaysResponse, error)
GetV1StreaksCurrentStreakDaysWithResponse request returning *GetV1StreaksCurrentStreakDaysResponse
func (*ClientWithResponses) GetV1StreaksWithResponse ¶
func (c *ClientWithResponses) GetV1StreaksWithResponse(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*GetV1StreaksResponse, error)
GetV1StreaksWithResponse request returning *GetV1StreaksResponse
func (*ClientWithResponses) GetV1UsersNotificationsWithResponse ¶
func (c *ClientWithResponses) GetV1UsersNotificationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersNotificationsResponse, error)
GetV1UsersNotificationsWithResponse request returning *GetV1UsersNotificationsResponse
func (*ClientWithResponses) GetV1UsersProfileWithResponse ¶
func (c *ClientWithResponses) GetV1UsersProfileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersProfileResponse, error)
GetV1UsersProfileWithResponse request returning *GetV1UsersProfileResponse
func (*ClientWithResponses) PatchV1NotesNoteIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PatchV1NotesNoteIdWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchV1NotesNoteIdResponse, error)
PatchV1NotesNoteIdWithBodyWithResponse request with arbitrary body returning *PatchV1NotesNoteIdResponse
func (*ClientWithResponses) PatchV1NotesNoteIdWithResponse ¶
func (c *ClientWithResponses) PatchV1NotesNoteIdWithResponse(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchV1NotesNoteIdResponse, error)
func (*ClientWithResponses) PostV1ActivityDaysWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1ActivityDaysWithBodyWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1ActivityDaysResponse, error)
PostV1ActivityDaysWithBodyWithResponse request with arbitrary body returning *PostV1ActivityDaysResponse
func (*ClientWithResponses) PostV1ActivityDaysWithResponse ¶
func (c *ClientWithResponses) PostV1ActivityDaysWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, body PostV1ActivityDaysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1ActivityDaysResponse, error)
func (*ClientWithResponses) PostV1BookmarksWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1BookmarksWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1BookmarksResponse, error)
PostV1BookmarksWithBodyWithResponse request with arbitrary body returning *PostV1BookmarksResponse
func (*ClientWithResponses) PostV1BookmarksWithResponse ¶
func (c *ClientWithResponses) PostV1BookmarksWithResponse(ctx context.Context, body PostV1BookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1BookmarksResponse, error)
func (*ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse request with arbitrary body returning *PostV1CollectionsCollectionIdBookmarksResponse
func (*ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsCollectionIdBookmarksWithResponse(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdBookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
func (*ClientWithResponses) PostV1CollectionsCollectionIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsCollectionIdWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdResponse, error)
PostV1CollectionsCollectionIdWithBodyWithResponse request with arbitrary body returning *PostV1CollectionsCollectionIdResponse
func (*ClientWithResponses) PostV1CollectionsCollectionIdWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdResponse, error)
func (*ClientWithResponses) PostV1CollectionsWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsResponse, error)
PostV1CollectionsWithBodyWithResponse request with arbitrary body returning *PostV1CollectionsResponse
func (*ClientWithResponses) PostV1CollectionsWithResponse ¶
func (c *ClientWithResponses) PostV1CollectionsWithResponse(ctx context.Context, body PostV1CollectionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsResponse, error)
func (*ClientWithResponses) PostV1CommentsWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1CommentsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CommentsResponse, error)
PostV1CommentsWithBodyWithResponse request with arbitrary body returning *PostV1CommentsResponse
func (*ClientWithResponses) PostV1CommentsWithResponse ¶
func (c *ClientWithResponses) PostV1CommentsWithResponse(ctx context.Context, body PostV1CommentsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CommentsResponse, error)
func (*ClientWithResponses) PostV1GoalsWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1GoalsWithBodyWithResponse(ctx context.Context, params *PostV1GoalsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1GoalsResponse, error)
PostV1GoalsWithBodyWithResponse request with arbitrary body returning *PostV1GoalsResponse
func (*ClientWithResponses) PostV1GoalsWithResponse ¶
func (c *ClientWithResponses) PostV1GoalsWithResponse(ctx context.Context, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1GoalsResponse, error)
func (*ClientWithResponses) PostV1NotesNoteIdPublishWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1NotesNoteIdPublishWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1NotesNoteIdPublishResponse, error)
PostV1NotesNoteIdPublishWithBodyWithResponse request with arbitrary body returning *PostV1NotesNoteIdPublishResponse
func (*ClientWithResponses) PostV1NotesNoteIdPublishWithResponse ¶
func (c *ClientWithResponses) PostV1NotesNoteIdPublishWithResponse(ctx context.Context, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1NotesNoteIdPublishResponse, error)
func (*ClientWithResponses) PostV1NotesWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1NotesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1NotesResponse, error)
PostV1NotesWithBodyWithResponse request with arbitrary body returning *PostV1NotesResponse
func (*ClientWithResponses) PostV1NotesWithResponse ¶
func (c *ClientWithResponses) PostV1NotesWithResponse(ctx context.Context, body PostV1NotesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1NotesResponse, error)
func (*ClientWithResponses) PostV1PostsReportPostIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PostsReportPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsReportPostIdResponse, error)
PostV1PostsReportPostIdWithBodyWithResponse request with arbitrary body returning *PostV1PostsReportPostIdResponse
func (*ClientWithResponses) PostV1PostsReportPostIdWithResponse ¶
func (c *ClientWithResponses) PostV1PostsReportPostIdWithResponse(ctx context.Context, postId string, body PostV1PostsReportPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsReportPostIdResponse, error)
func (*ClientWithResponses) PostV1PostsToggleLikePostIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PostsToggleLikePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsToggleLikePostIdResponse, error)
PostV1PostsToggleLikePostIdWithBodyWithResponse request with arbitrary body returning *PostV1PostsToggleLikePostIdResponse
func (*ClientWithResponses) PostV1PostsToggleLikePostIdWithResponse ¶
func (c *ClientWithResponses) PostV1PostsToggleLikePostIdWithResponse(ctx context.Context, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsToggleLikePostIdResponse, error)
func (*ClientWithResponses) PostV1PostsToggleSavePostIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PostsToggleSavePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsToggleSavePostIdResponse, error)
PostV1PostsToggleSavePostIdWithBodyWithResponse request with arbitrary body returning *PostV1PostsToggleSavePostIdResponse
func (*ClientWithResponses) PostV1PostsToggleSavePostIdWithResponse ¶
func (c *ClientWithResponses) PostV1PostsToggleSavePostIdWithResponse(ctx context.Context, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsToggleSavePostIdResponse, error)
func (*ClientWithResponses) PostV1PostsViewPostIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PostsViewPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsViewPostIdResponse, error)
PostV1PostsViewPostIdWithBodyWithResponse request with arbitrary body returning *PostV1PostsViewPostIdResponse
func (*ClientWithResponses) PostV1PostsViewPostIdWithResponse ¶
func (c *ClientWithResponses) PostV1PostsViewPostIdWithResponse(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsViewPostIdResponse, error)
func (*ClientWithResponses) PostV1PostsWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PostsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsResponse, error)
PostV1PostsWithBodyWithResponse request with arbitrary body returning *PostV1PostsResponse
func (*ClientWithResponses) PostV1PostsWithResponse ¶
func (c *ClientWithResponses) PostV1PostsWithResponse(ctx context.Context, body PostV1PostsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsResponse, error)
func (*ClientWithResponses) PostV1PreferencesBulkWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PreferencesBulkWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PreferencesBulkResponse, error)
PostV1PreferencesBulkWithBodyWithResponse request with arbitrary body returning *PostV1PreferencesBulkResponse
func (*ClientWithResponses) PostV1PreferencesBulkWithResponse ¶
func (c *ClientWithResponses) PostV1PreferencesBulkWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, body PostV1PreferencesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PreferencesBulkResponse, error)
func (*ClientWithResponses) PostV1PreferencesWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1PreferencesWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PreferencesResponse, error)
PostV1PreferencesWithBodyWithResponse request with arbitrary body returning *PostV1PreferencesResponse
func (*ClientWithResponses) PostV1PreferencesWithResponse ¶
func (c *ClientWithResponses) PostV1PreferencesWithResponse(ctx context.Context, params *PostV1PreferencesParams, body PostV1PreferencesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PreferencesResponse, error)
func (*ClientWithResponses) PostV1ReadingSessionsWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1ReadingSessionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1ReadingSessionsResponse, error)
PostV1ReadingSessionsWithBodyWithResponse request with arbitrary body returning *PostV1ReadingSessionsResponse
func (*ClientWithResponses) PostV1ReadingSessionsWithResponse ¶
func (c *ClientWithResponses) PostV1ReadingSessionsWithResponse(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1ReadingSessionsResponse, error)
func (*ClientWithResponses) PostV1UsersConfirmationEmailWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1UsersConfirmationEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersConfirmationEmailResponse, error)
PostV1UsersConfirmationEmailWithBodyWithResponse request with arbitrary body returning *PostV1UsersConfirmationEmailResponse
func (*ClientWithResponses) PostV1UsersConfirmationEmailWithResponse ¶
func (c *ClientWithResponses) PostV1UsersConfirmationEmailWithResponse(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersConfirmationEmailResponse, error)
func (*ClientWithResponses) PostV1UsersPasswordResetEmailWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1UsersPasswordResetEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersPasswordResetEmailResponse, error)
PostV1UsersPasswordResetEmailWithBodyWithResponse request with arbitrary body returning *PostV1UsersPasswordResetEmailResponse
func (*ClientWithResponses) PostV1UsersPasswordResetEmailWithResponse ¶
func (c *ClientWithResponses) PostV1UsersPasswordResetEmailWithResponse(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersPasswordResetEmailResponse, error)
func (*ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse request with arbitrary body returning *PostV1UsersUsernameRegisterAndroidDeviceResponse
func (*ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithResponse ¶
func (c *ClientWithResponses) PostV1UsersUsernameRegisterAndroidDeviceWithResponse(ctx context.Context, username string, body PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
func (*ClientWithResponses) PostV1UsersUsernameToggleFollowWithBodyWithResponse ¶
func (c *ClientWithResponses) PostV1UsersUsernameToggleFollowWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameToggleFollowResponse, error)
PostV1UsersUsernameToggleFollowWithBodyWithResponse request with arbitrary body returning *PostV1UsersUsernameToggleFollowResponse
func (*ClientWithResponses) PostV1UsersUsernameToggleFollowWithResponse ¶
func (c *ClientWithResponses) PostV1UsersUsernameToggleFollowWithResponse(ctx context.Context, username string, body PostV1UsersUsernameToggleFollowJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameToggleFollowResponse, error)
func (*ClientWithResponses) PutV1CommentsCommentIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1CommentsCommentIdWithBodyWithResponse(ctx context.Context, commentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1CommentsCommentIdResponse, error)
PutV1CommentsCommentIdWithBodyWithResponse request with arbitrary body returning *PutV1CommentsCommentIdResponse
func (*ClientWithResponses) PutV1CommentsCommentIdWithResponse ¶
func (c *ClientWithResponses) PutV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, body PutV1CommentsCommentIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1CommentsCommentIdResponse, error)
func (*ClientWithResponses) PutV1GoalsIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1GoalsIdWithBodyWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GoalsIdResponse, error)
PutV1GoalsIdWithBodyWithResponse request with arbitrary body returning *PutV1GoalsIdResponse
func (*ClientWithResponses) PutV1GoalsIdWithResponse ¶
func (c *ClientWithResponses) PutV1GoalsIdWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, body PutV1GoalsIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GoalsIdResponse, error)
func (*ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse request with arbitrary body returning *PutV1GroupsGroupIdAssignAsAdminResponse
func (*ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdAssignAsAdminWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdAssignAsAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
func (*ClientWithResponses) PutV1GroupsGroupIdInviteUserWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdInviteUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdInviteUserResponse, error)
PutV1GroupsGroupIdInviteUserWithBodyWithResponse request with arbitrary body returning *PutV1GroupsGroupIdInviteUserResponse
func (*ClientWithResponses) PutV1GroupsGroupIdInviteUserWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdInviteUserWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdInviteUserJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdInviteUserResponse, error)
func (*ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdRemoveUserResponse, error)
PutV1GroupsGroupIdRemoveUserWithBodyWithResponse request with arbitrary body returning *PutV1GroupsGroupIdRemoveUserResponse
func (*ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithResponse ¶
func (c *ClientWithResponses) PutV1GroupsGroupIdRemoveUserWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdRemoveUserJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdRemoveUserResponse, error)
func (*ClientWithResponses) PutV1PostsPostIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1PostsPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1PostsPostIdResponse, error)
PutV1PostsPostIdWithBodyWithResponse request with arbitrary body returning *PutV1PostsPostIdResponse
func (*ClientWithResponses) PutV1PostsPostIdWithResponse ¶
func (c *ClientWithResponses) PutV1PostsPostIdWithResponse(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1PostsPostIdResponse, error)
func (*ClientWithResponses) PutV1UsersNotificationsSettingIdWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1UsersNotificationsSettingIdWithBodyWithResponse(ctx context.Context, settingId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1UsersNotificationsSettingIdResponse, error)
PutV1UsersNotificationsSettingIdWithBodyWithResponse request with arbitrary body returning *PutV1UsersNotificationsSettingIdResponse
func (*ClientWithResponses) PutV1UsersNotificationsSettingIdWithResponse ¶
func (c *ClientWithResponses) PutV1UsersNotificationsSettingIdWithResponse(ctx context.Context, settingId string, body PutV1UsersNotificationsSettingIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1UsersNotificationsSettingIdResponse, error)
func (*ClientWithResponses) PutV1UsersProfileWithBodyWithResponse ¶
func (c *ClientWithResponses) PutV1UsersProfileWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1UsersProfileResponse, error)
PutV1UsersProfileWithBodyWithResponse request with arbitrary body returning *PutV1UsersProfileResponse
func (*ClientWithResponses) PutV1UsersProfileWithResponse ¶
func (c *ClientWithResponses) PutV1UsersProfileWithResponse(ctx context.Context, body PutV1UsersProfileJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1UsersProfileResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetV1ActivityDaysWithResponse request
GetV1ActivityDaysWithResponse(ctx context.Context, params *GetV1ActivityDaysParams, reqEditors ...RequestEditorFn) (*GetV1ActivityDaysResponse, error)
// PostV1ActivityDaysWithBodyWithResponse request with any body
PostV1ActivityDaysWithBodyWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1ActivityDaysResponse, error)
PostV1ActivityDaysWithResponse(ctx context.Context, params *PostV1ActivityDaysParams, body PostV1ActivityDaysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1ActivityDaysResponse, error)
// GetV1ActivityDaysEstimateReadingTimeWithResponse request
GetV1ActivityDaysEstimateReadingTimeWithResponse(ctx context.Context, params *GetV1ActivityDaysEstimateReadingTimeParams, reqEditors ...RequestEditorFn) (*GetV1ActivityDaysEstimateReadingTimeResponse, error)
// GetV1BookmarksWithResponse request
GetV1BookmarksWithResponse(ctx context.Context, params *GetV1BookmarksParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksResponse, error)
// PostV1BookmarksWithBodyWithResponse request with any body
PostV1BookmarksWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1BookmarksResponse, error)
PostV1BookmarksWithResponse(ctx context.Context, body PostV1BookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1BookmarksResponse, error)
// GetV1BookmarksAyahsRangeWithResponse request
GetV1BookmarksAyahsRangeWithResponse(ctx context.Context, params *GetV1BookmarksAyahsRangeParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksAyahsRangeResponse, error)
// GetV1BookmarksBookmarkWithResponse request
GetV1BookmarksBookmarkWithResponse(ctx context.Context, params *GetV1BookmarksBookmarkParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksBookmarkResponse, error)
// GetV1BookmarksCollectionsWithResponse request
GetV1BookmarksCollectionsWithResponse(ctx context.Context, params *GetV1BookmarksCollectionsParams, reqEditors ...RequestEditorFn) (*GetV1BookmarksCollectionsResponse, error)
// DeleteV1BookmarksBookmarkIdWithResponse request
DeleteV1BookmarksBookmarkIdWithResponse(ctx context.Context, bookmarkId string, reqEditors ...RequestEditorFn) (*DeleteV1BookmarksBookmarkIdResponse, error)
// GetV1CollectionsWithResponse request
GetV1CollectionsWithResponse(ctx context.Context, params *GetV1CollectionsParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsResponse, error)
// PostV1CollectionsWithBodyWithResponse request with any body
PostV1CollectionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsResponse, error)
PostV1CollectionsWithResponse(ctx context.Context, body PostV1CollectionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsResponse, error)
// GetV1CollectionsAllWithResponse request
GetV1CollectionsAllWithResponse(ctx context.Context, params *GetV1CollectionsAllParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsAllResponse, error)
// DeleteV1CollectionsCollectionIdWithResponse request
DeleteV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, reqEditors ...RequestEditorFn) (*DeleteV1CollectionsCollectionIdResponse, error)
// GetV1CollectionsCollectionIdWithResponse request
GetV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, params *GetV1CollectionsCollectionIdParams, reqEditors ...RequestEditorFn) (*GetV1CollectionsCollectionIdResponse, error)
// PostV1CollectionsCollectionIdWithBodyWithResponse request with any body
PostV1CollectionsCollectionIdWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdResponse, error)
PostV1CollectionsCollectionIdWithResponse(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdResponse, error)
// PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse request with any body
PostV1CollectionsCollectionIdBookmarksWithBodyWithResponse(ctx context.Context, collectionId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
PostV1CollectionsCollectionIdBookmarksWithResponse(ctx context.Context, collectionId string, body PostV1CollectionsCollectionIdBookmarksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
// DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse request
DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse(ctx context.Context, collectionId string, bookmarkId string, reqEditors ...RequestEditorFn) (*DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse, error)
// PostV1CommentsWithBodyWithResponse request with any body
PostV1CommentsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1CommentsResponse, error)
PostV1CommentsWithResponse(ctx context.Context, body PostV1CommentsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1CommentsResponse, error)
// DeleteV1CommentsCommentIdWithResponse request
DeleteV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, reqEditors ...RequestEditorFn) (*DeleteV1CommentsCommentIdResponse, error)
// PutV1CommentsCommentIdWithBodyWithResponse request with any body
PutV1CommentsCommentIdWithBodyWithResponse(ctx context.Context, commentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1CommentsCommentIdResponse, error)
PutV1CommentsCommentIdWithResponse(ctx context.Context, commentId string, body PutV1CommentsCommentIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1CommentsCommentIdResponse, error)
// PostV1GoalsWithBodyWithResponse request with any body
PostV1GoalsWithBodyWithResponse(ctx context.Context, params *PostV1GoalsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1GoalsResponse, error)
PostV1GoalsWithResponse(ctx context.Context, params *PostV1GoalsParams, body PostV1GoalsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1GoalsResponse, error)
// GetV1GoalsEstimateWithResponse request
GetV1GoalsEstimateWithResponse(ctx context.Context, params *GetV1GoalsEstimateParams, reqEditors ...RequestEditorFn) (*GetV1GoalsEstimateResponse, error)
// GetV1GoalsGetTodaysPlanWithResponse request
GetV1GoalsGetTodaysPlanWithResponse(ctx context.Context, params *GetV1GoalsGetTodaysPlanParams, reqEditors ...RequestEditorFn) (*GetV1GoalsGetTodaysPlanResponse, error)
// DeleteV1GoalsIdWithResponse request
DeleteV1GoalsIdWithResponse(ctx context.Context, id string, params *DeleteV1GoalsIdParams, reqEditors ...RequestEditorFn) (*DeleteV1GoalsIdResponse, error)
// PutV1GoalsIdWithBodyWithResponse request with any body
PutV1GoalsIdWithBodyWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GoalsIdResponse, error)
PutV1GoalsIdWithResponse(ctx context.Context, id string, params *PutV1GoalsIdParams, body PutV1GoalsIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GoalsIdResponse, error)
// GetV1GroupsWithResponse request
GetV1GroupsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1GroupsResponse, error)
// GetV1GroupsGroupIdWithResponse request
GetV1GroupsGroupIdWithResponse(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*GetV1GroupsGroupIdResponse, error)
// PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse request with any body
PutV1GroupsGroupIdAssignAsAdminWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
PutV1GroupsGroupIdAssignAsAdminWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdAssignAsAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
// PutV1GroupsGroupIdInviteUserWithBodyWithResponse request with any body
PutV1GroupsGroupIdInviteUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdInviteUserResponse, error)
PutV1GroupsGroupIdInviteUserWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdInviteUserJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdInviteUserResponse, error)
// PutV1GroupsGroupIdRemoveUserWithBodyWithResponse request with any body
PutV1GroupsGroupIdRemoveUserWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdRemoveUserResponse, error)
PutV1GroupsGroupIdRemoveUserWithResponse(ctx context.Context, groupId string, body PutV1GroupsGroupIdRemoveUserJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1GroupsGroupIdRemoveUserResponse, error)
// GetV1NotesWithResponse request
GetV1NotesWithResponse(ctx context.Context, params *GetV1NotesParams, reqEditors ...RequestEditorFn) (*GetV1NotesResponse, error)
// PostV1NotesWithBodyWithResponse request with any body
PostV1NotesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1NotesResponse, error)
PostV1NotesWithResponse(ctx context.Context, body PostV1NotesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1NotesResponse, error)
// GetV1NotesByAttachedEntityWithResponse request
GetV1NotesByAttachedEntityWithResponse(ctx context.Context, params *GetV1NotesByAttachedEntityParams, reqEditors ...RequestEditorFn) (*GetV1NotesByAttachedEntityResponse, error)
// GetV1NotesByRangeWithResponse request
GetV1NotesByRangeWithResponse(ctx context.Context, params *GetV1NotesByRangeParams, reqEditors ...RequestEditorFn) (*GetV1NotesByRangeResponse, error)
// GetV1NotesByVerseVerseKeyWithResponse request
GetV1NotesByVerseVerseKeyWithResponse(ctx context.Context, verseKey string, reqEditors ...RequestEditorFn) (*GetV1NotesByVerseVerseKeyResponse, error)
// GetV1NotesCountWithinRangeWithResponse request
GetV1NotesCountWithinRangeWithResponse(ctx context.Context, params *GetV1NotesCountWithinRangeParams, reqEditors ...RequestEditorFn) (*GetV1NotesCountWithinRangeResponse, error)
// DeleteV1NotesNoteIdWithResponse request
DeleteV1NotesNoteIdWithResponse(ctx context.Context, noteId string, reqEditors ...RequestEditorFn) (*DeleteV1NotesNoteIdResponse, error)
// GetV1NotesNoteIdWithResponse request
GetV1NotesNoteIdWithResponse(ctx context.Context, noteId string, params *GetV1NotesNoteIdParams, reqEditors ...RequestEditorFn) (*GetV1NotesNoteIdResponse, error)
// PatchV1NotesNoteIdWithBodyWithResponse request with any body
PatchV1NotesNoteIdWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchV1NotesNoteIdResponse, error)
PatchV1NotesNoteIdWithResponse(ctx context.Context, noteId string, body PatchV1NotesNoteIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchV1NotesNoteIdResponse, error)
// PostV1NotesNoteIdPublishWithBodyWithResponse request with any body
PostV1NotesNoteIdPublishWithBodyWithResponse(ctx context.Context, noteId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1NotesNoteIdPublishResponse, error)
PostV1NotesNoteIdPublishWithResponse(ctx context.Context, noteId string, body PostV1NotesNoteIdPublishJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1NotesNoteIdPublishResponse, error)
// GetV1PostsWithResponse request
GetV1PostsWithResponse(ctx context.Context, params *GetV1PostsParams, reqEditors ...RequestEditorFn) (*GetV1PostsResponse, error)
// PostV1PostsWithBodyWithResponse request with any body
PostV1PostsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsResponse, error)
PostV1PostsWithResponse(ctx context.Context, body PostV1PostsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsResponse, error)
// PostV1PostsReportPostIdWithBodyWithResponse request with any body
PostV1PostsReportPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsReportPostIdResponse, error)
PostV1PostsReportPostIdWithResponse(ctx context.Context, postId string, body PostV1PostsReportPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsReportPostIdResponse, error)
// PostV1PostsToggleLikePostIdWithBodyWithResponse request with any body
PostV1PostsToggleLikePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsToggleLikePostIdResponse, error)
PostV1PostsToggleLikePostIdWithResponse(ctx context.Context, postId string, body PostV1PostsToggleLikePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsToggleLikePostIdResponse, error)
// PostV1PostsToggleSavePostIdWithBodyWithResponse request with any body
PostV1PostsToggleSavePostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsToggleSavePostIdResponse, error)
PostV1PostsToggleSavePostIdWithResponse(ctx context.Context, postId string, body PostV1PostsToggleSavePostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsToggleSavePostIdResponse, error)
// PostV1PostsViewPostIdWithBodyWithResponse request with any body
PostV1PostsViewPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PostsViewPostIdResponse, error)
PostV1PostsViewPostIdWithResponse(ctx context.Context, postId string, body PostV1PostsViewPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PostsViewPostIdResponse, error)
// DeleteV1PostsPostIdWithResponse request
DeleteV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*DeleteV1PostsPostIdResponse, error)
// GetV1PostsPostIdWithResponse request
GetV1PostsPostIdWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdResponse, error)
// PutV1PostsPostIdWithBodyWithResponse request with any body
PutV1PostsPostIdWithBodyWithResponse(ctx context.Context, postId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1PostsPostIdResponse, error)
PutV1PostsPostIdWithResponse(ctx context.Context, postId string, body PutV1PostsPostIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1PostsPostIdResponse, error)
// GetV1PostsPostIdCommentsWithResponse request
GetV1PostsPostIdCommentsWithResponse(ctx context.Context, postId string, reqEditors ...RequestEditorFn) (*GetV1PostsPostIdCommentsResponse, error)
// GetV1PreferencesWithResponse request
GetV1PreferencesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1PreferencesResponse, error)
// PostV1PreferencesWithBodyWithResponse request with any body
PostV1PreferencesWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PreferencesResponse, error)
PostV1PreferencesWithResponse(ctx context.Context, params *PostV1PreferencesParams, body PostV1PreferencesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PreferencesResponse, error)
// PostV1PreferencesBulkWithBodyWithResponse request with any body
PostV1PreferencesBulkWithBodyWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1PreferencesBulkResponse, error)
PostV1PreferencesBulkWithResponse(ctx context.Context, params *PostV1PreferencesBulkParams, body PostV1PreferencesBulkJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1PreferencesBulkResponse, error)
// GetV1ReadingSessionsWithResponse request
GetV1ReadingSessionsWithResponse(ctx context.Context, params *GetV1ReadingSessionsParams, reqEditors ...RequestEditorFn) (*GetV1ReadingSessionsResponse, error)
// PostV1ReadingSessionsWithBodyWithResponse request with any body
PostV1ReadingSessionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1ReadingSessionsResponse, error)
PostV1ReadingSessionsWithResponse(ctx context.Context, body PostV1ReadingSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1ReadingSessionsResponse, error)
// GetV1StreaksWithResponse request
GetV1StreaksWithResponse(ctx context.Context, params *GetV1StreaksParams, reqEditors ...RequestEditorFn) (*GetV1StreaksResponse, error)
// GetV1StreaksCurrentStreakDaysWithResponse request
GetV1StreaksCurrentStreakDaysWithResponse(ctx context.Context, params *GetV1StreaksCurrentStreakDaysParams, reqEditors ...RequestEditorFn) (*GetV1StreaksCurrentStreakDaysResponse, error)
// PostV1UsersConfirmationEmailWithBodyWithResponse request with any body
PostV1UsersConfirmationEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersConfirmationEmailResponse, error)
PostV1UsersConfirmationEmailWithResponse(ctx context.Context, body PostV1UsersConfirmationEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersConfirmationEmailResponse, error)
// GetV1UsersNotificationsWithResponse request
GetV1UsersNotificationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersNotificationsResponse, error)
// PutV1UsersNotificationsSettingIdWithBodyWithResponse request with any body
PutV1UsersNotificationsSettingIdWithBodyWithResponse(ctx context.Context, settingId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1UsersNotificationsSettingIdResponse, error)
PutV1UsersNotificationsSettingIdWithResponse(ctx context.Context, settingId string, body PutV1UsersNotificationsSettingIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1UsersNotificationsSettingIdResponse, error)
// PostV1UsersPasswordResetEmailWithBodyWithResponse request with any body
PostV1UsersPasswordResetEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersPasswordResetEmailResponse, error)
PostV1UsersPasswordResetEmailWithResponse(ctx context.Context, body PostV1UsersPasswordResetEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersPasswordResetEmailResponse, error)
// GetV1UsersProfileWithResponse request
GetV1UsersProfileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetV1UsersProfileResponse, error)
// PutV1UsersProfileWithBodyWithResponse request with any body
PutV1UsersProfileWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutV1UsersProfileResponse, error)
PutV1UsersProfileWithResponse(ctx context.Context, body PutV1UsersProfileJSONRequestBody, reqEditors ...RequestEditorFn) (*PutV1UsersProfileResponse, error)
// PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse request with any body
PostV1UsersUsernameRegisterAndroidDeviceWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
PostV1UsersUsernameRegisterAndroidDeviceWithResponse(ctx context.Context, username string, body PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
// PostV1UsersUsernameToggleFollowWithBodyWithResponse request with any body
PostV1UsersUsernameToggleFollowWithBodyWithResponse(ctx context.Context, username string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameToggleFollowResponse, error)
PostV1UsersUsernameToggleFollowWithResponse(ctx context.Context, username string, body PostV1UsersUsernameToggleFollowJSONRequestBody, reqEditors ...RequestEditorFn) (*PostV1UsersUsernameToggleFollowResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Collection ¶
type Collection struct {
Id string `json:"id"`
Name string `json:"name"`
UpdatedAt time.Time `json:"updatedAt"`
}
Collection defines model for Collection.
type Comment ¶
type Comment struct {
// Author Details about the author.
Author *Author `json:"author,omitempty"`
// Body The body of the comment.
Body string `json:"body"`
// CreatedAt The creation date of the comment.
CreatedAt string `json:"createdAt"`
// Hidden Whether the comment is hidden.
Hidden bool `json:"hidden"`
// Id The id of the comment.
Id int `json:"id"`
// ParentId The parent comment's id. Will be `null` if this comment does not have a parent.
ParentId *int `json:"parentId"`
}
Comment defines model for Comment.
type DeleteV1BookmarksBookmarkIdResponse ¶
type DeleteV1BookmarksBookmarkIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1BookmarksBookmarkIdResponse ¶
func ParseDeleteV1BookmarksBookmarkIdResponse(rsp *http.Response) (*DeleteV1BookmarksBookmarkIdResponse, error)
ParseDeleteV1BookmarksBookmarkIdResponse parses an HTTP response from a DeleteV1BookmarksBookmarkIdWithResponse call
func (DeleteV1BookmarksBookmarkIdResponse) Status ¶
func (r DeleteV1BookmarksBookmarkIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1BookmarksBookmarkIdResponse) StatusCode ¶
func (r DeleteV1BookmarksBookmarkIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse ¶
type DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse ¶
func ParseDeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse(rsp *http.Response) (*DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse, error)
ParseDeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse parses an HTTP response from a DeleteV1CollectionsCollectionIdBookmarksBookmarkIdWithResponse call
func (DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse) Status ¶
func (r DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse) StatusCode ¶
func (r DeleteV1CollectionsCollectionIdBookmarksBookmarkIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1CollectionsCollectionIdResponse ¶
type DeleteV1CollectionsCollectionIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1CollectionsCollectionIdResponse ¶
func ParseDeleteV1CollectionsCollectionIdResponse(rsp *http.Response) (*DeleteV1CollectionsCollectionIdResponse, error)
ParseDeleteV1CollectionsCollectionIdResponse parses an HTTP response from a DeleteV1CollectionsCollectionIdWithResponse call
func (DeleteV1CollectionsCollectionIdResponse) Status ¶
func (r DeleteV1CollectionsCollectionIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1CollectionsCollectionIdResponse) StatusCode ¶
func (r DeleteV1CollectionsCollectionIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1CommentsCommentIdResponse ¶
type DeleteV1CommentsCommentIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1CommentsCommentIdResponse ¶
func ParseDeleteV1CommentsCommentIdResponse(rsp *http.Response) (*DeleteV1CommentsCommentIdResponse, error)
ParseDeleteV1CommentsCommentIdResponse parses an HTTP response from a DeleteV1CommentsCommentIdWithResponse call
func (DeleteV1CommentsCommentIdResponse) Status ¶
func (r DeleteV1CommentsCommentIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1CommentsCommentIdResponse) StatusCode ¶
func (r DeleteV1CommentsCommentIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1GoalsIdParams ¶
type DeleteV1GoalsIdParams struct {
// Category The category of the goal
Category DeleteV1GoalsIdParamsCategory `form:"category" json:"category"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
DeleteV1GoalsIdParams defines parameters for DeleteV1GoalsId.
type DeleteV1GoalsIdParamsCategory ¶
type DeleteV1GoalsIdParamsCategory string
DeleteV1GoalsIdParamsCategory defines parameters for DeleteV1GoalsId.
const ( DeleteV1GoalsIdParamsCategoryCOURSE DeleteV1GoalsIdParamsCategory = "COURSE" DeleteV1GoalsIdParamsCategoryQURAN DeleteV1GoalsIdParamsCategory = "QURAN" DeleteV1GoalsIdParamsCategoryQURANREADINGPROGRAM DeleteV1GoalsIdParamsCategory = "QURAN_READING_PROGRAM" )
Defines values for DeleteV1GoalsIdParamsCategory.
type DeleteV1GoalsIdResponse ¶
type DeleteV1GoalsIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1GoalsIdResponse ¶
func ParseDeleteV1GoalsIdResponse(rsp *http.Response) (*DeleteV1GoalsIdResponse, error)
ParseDeleteV1GoalsIdResponse parses an HTTP response from a DeleteV1GoalsIdWithResponse call
func (DeleteV1GoalsIdResponse) Status ¶
func (r DeleteV1GoalsIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1GoalsIdResponse) StatusCode ¶
func (r DeleteV1GoalsIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1NotesNoteIdResponse ¶
type DeleteV1NotesNoteIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Success *bool `json:"success,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1NotesNoteIdResponse ¶
func ParseDeleteV1NotesNoteIdResponse(rsp *http.Response) (*DeleteV1NotesNoteIdResponse, error)
ParseDeleteV1NotesNoteIdResponse parses an HTTP response from a DeleteV1NotesNoteIdWithResponse call
func (DeleteV1NotesNoteIdResponse) Status ¶
func (r DeleteV1NotesNoteIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1NotesNoteIdResponse) StatusCode ¶
func (r DeleteV1NotesNoteIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteV1PostsPostIdResponse ¶
type DeleteV1PostsPostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseDeleteV1PostsPostIdResponse ¶
func ParseDeleteV1PostsPostIdResponse(rsp *http.Response) (*DeleteV1PostsPostIdResponse, error)
ParseDeleteV1PostsPostIdResponse parses an HTTP response from a DeleteV1PostsPostIdWithResponse call
func (DeleteV1PostsPostIdResponse) Status ¶
func (r DeleteV1PostsPostIdResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteV1PostsPostIdResponse) StatusCode ¶
func (r DeleteV1PostsPostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EstimatedGoalTimeline ¶
type EstimatedGoalTimeline struct {
Week *[]EstimatedGoalTimelineDay `json:"week,omitempty"`
}
EstimatedGoalTimeline defines model for EstimatedGoalTimeline.
type EstimatedGoalTimelineDay ¶
type EstimatedGoalTimelineDay struct {
// Amount The amount of the day's goal.
Amount EstimatedGoalTimelineDay_Amount `json:"amount"`
// Date The date of the estimated day
Date time.Time `json:"date"`
}
EstimatedGoalTimelineDay defines model for EstimatedGoalTimelineDay.
type EstimatedGoalTimelineDayAmount0 ¶
type EstimatedGoalTimelineDayAmount0 = string
EstimatedGoalTimelineDayAmount0 defines model for .
type EstimatedGoalTimelineDayAmount1 ¶
type EstimatedGoalTimelineDayAmount1 = int
EstimatedGoalTimelineDayAmount1 defines model for .
type EstimatedGoalTimelineDay_Amount ¶
type EstimatedGoalTimelineDay_Amount struct {
// contains filtered or unexported fields
}
EstimatedGoalTimelineDay_Amount The amount of the day's goal.
func (EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount0 ¶
func (t EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount0() (EstimatedGoalTimelineDayAmount0, error)
AsEstimatedGoalTimelineDayAmount0 returns the union data inside the EstimatedGoalTimelineDay_Amount as a EstimatedGoalTimelineDayAmount0
func (EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount1 ¶
func (t EstimatedGoalTimelineDay_Amount) AsEstimatedGoalTimelineDayAmount1() (EstimatedGoalTimelineDayAmount1, error)
AsEstimatedGoalTimelineDayAmount1 returns the union data inside the EstimatedGoalTimelineDay_Amount as a EstimatedGoalTimelineDayAmount1
func (*EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount0 ¶
func (t *EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount0(v EstimatedGoalTimelineDayAmount0) error
FromEstimatedGoalTimelineDayAmount0 overwrites any union data inside the EstimatedGoalTimelineDay_Amount as the provided EstimatedGoalTimelineDayAmount0
func (*EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount1 ¶
func (t *EstimatedGoalTimelineDay_Amount) FromEstimatedGoalTimelineDayAmount1(v EstimatedGoalTimelineDayAmount1) error
FromEstimatedGoalTimelineDayAmount1 overwrites any union data inside the EstimatedGoalTimelineDay_Amount as the provided EstimatedGoalTimelineDayAmount1
func (EstimatedGoalTimelineDay_Amount) MarshalJSON ¶
func (t EstimatedGoalTimelineDay_Amount) MarshalJSON() ([]byte, error)
func (*EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount0 ¶
func (t *EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount0(v EstimatedGoalTimelineDayAmount0) error
MergeEstimatedGoalTimelineDayAmount0 performs a merge with any union data inside the EstimatedGoalTimelineDay_Amount, using the provided EstimatedGoalTimelineDayAmount0
func (*EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount1 ¶
func (t *EstimatedGoalTimelineDay_Amount) MergeEstimatedGoalTimelineDayAmount1(v EstimatedGoalTimelineDayAmount1) error
MergeEstimatedGoalTimelineDayAmount1 performs a merge with any union data inside the EstimatedGoalTimelineDay_Amount, using the provided EstimatedGoalTimelineDayAmount1
func (*EstimatedGoalTimelineDay_Amount) UnmarshalJSON ¶
func (t *EstimatedGoalTimelineDay_Amount) UnmarshalJSON(b []byte) error
type GetV1ActivityDays200DataDailyTargetPages0 ¶
type GetV1ActivityDays200DataDailyTargetPages0 = float32
type GetV1ActivityDays200DataDailyTargetRanges0 ¶
type GetV1ActivityDays200DataDailyTargetRanges0 = []string
type GetV1ActivityDays200DataDailyTargetSeconds0 ¶
type GetV1ActivityDays200DataDailyTargetSeconds0 = int
type GetV1ActivityDays200DataManuallyAddedSeconds0 ¶
type GetV1ActivityDays200DataManuallyAddedSeconds0 = int
type GetV1ActivityDays200DataMushafId ¶
type GetV1ActivityDays200DataMushafId int
type GetV1ActivityDays200DataPagesRead0 ¶
type GetV1ActivityDays200DataPagesRead0 = float32
type GetV1ActivityDays200DataRanges0 ¶
type GetV1ActivityDays200DataRanges0 = []string
type GetV1ActivityDays200DataRemainingDailyTargetRanges0 ¶
type GetV1ActivityDays200DataRemainingDailyTargetRanges0 = []string
type GetV1ActivityDays200DataSecondsRead0 ¶
type GetV1ActivityDays200DataSecondsRead0 = int
type GetV1ActivityDays200DataType ¶
type GetV1ActivityDays200DataType string
type GetV1ActivityDays200DataVersesRead0 ¶
type GetV1ActivityDays200DataVersesRead0 = int
type GetV1ActivityDaysEstimateReadingTimeParams ¶
type GetV1ActivityDaysEstimateReadingTimeParams struct {
// Ranges a comma separated string of Ayah ranges e.g. 1:1-1:2
Ranges string `form:"ranges" json:"ranges"`
}
GetV1ActivityDaysEstimateReadingTimeParams defines parameters for GetV1ActivityDaysEstimateReadingTime.
type GetV1ActivityDaysEstimateReadingTimeResponse ¶
type GetV1ActivityDaysEstimateReadingTimeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Seconds The number of seconds it would take on average to read the range of Ayahs.
Seconds int `json:"seconds"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1ActivityDaysEstimateReadingTimeResponse ¶
func ParseGetV1ActivityDaysEstimateReadingTimeResponse(rsp *http.Response) (*GetV1ActivityDaysEstimateReadingTimeResponse, error)
ParseGetV1ActivityDaysEstimateReadingTimeResponse parses an HTTP response from a GetV1ActivityDaysEstimateReadingTimeWithResponse call
func (GetV1ActivityDaysEstimateReadingTimeResponse) Status ¶
func (r GetV1ActivityDaysEstimateReadingTimeResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1ActivityDaysEstimateReadingTimeResponse) StatusCode ¶
func (r GetV1ActivityDaysEstimateReadingTimeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1ActivityDaysParams ¶
type GetV1ActivityDaysParams struct {
// From The start date of the activity days
From *string `form:"from,omitempty" json:"from,omitempty"`
// To The last date of the activity days
To *string `form:"to,omitempty" json:"to,omitempty"`
// DateOrderBy Order by activity day's date
DateOrderBy *GetV1ActivityDaysParamsDateOrderBy `form:"dateOrderBy,omitempty" json:"dateOrderBy,omitempty"`
// Type The type of the activity day
Type *GetV1ActivityDaysParamsType `form:"type,omitempty" json:"type,omitempty"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1ActivityDaysParams defines parameters for GetV1ActivityDays.
type GetV1ActivityDaysParamsDateOrderBy ¶
type GetV1ActivityDaysParamsDateOrderBy string
GetV1ActivityDaysParamsDateOrderBy defines parameters for GetV1ActivityDays.
const ( GetV1ActivityDaysParamsDateOrderByAsc GetV1ActivityDaysParamsDateOrderBy = "asc" GetV1ActivityDaysParamsDateOrderByDesc GetV1ActivityDaysParamsDateOrderBy = "desc" )
Defines values for GetV1ActivityDaysParamsDateOrderBy.
type GetV1ActivityDaysParamsType ¶
type GetV1ActivityDaysParamsType string
GetV1ActivityDaysParamsType defines parameters for GetV1ActivityDays.
const ( GetV1ActivityDaysParamsTypeLESSON GetV1ActivityDaysParamsType = "LESSON" GetV1ActivityDaysParamsTypeQURAN GetV1ActivityDaysParamsType = "QURAN" GetV1ActivityDaysParamsTypeQURANREADINGPROGRAM GetV1ActivityDaysParamsType = "QURAN_READING_PROGRAM" )
Defines values for GetV1ActivityDaysParamsType.
type GetV1ActivityDaysResponse ¶
type GetV1ActivityDaysResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// DailyTargetPages The number of pages user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetPages *GetV1ActivityDays_200_Data_DailyTargetPages `json:"dailyTargetPages,omitempty"`
// DailyTargetRanges The range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetRanges *GetV1ActivityDays_200_Data_DailyTargetRanges `json:"dailyTargetRanges,omitempty"`
// DailyTargetSeconds The number of seconds user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetSeconds *GetV1ActivityDays_200_Data_DailyTargetSeconds `json:"dailyTargetSeconds,omitempty"`
// Date The date of the activity day.
Date string `json:"date"`
// Id The id of the activity day.
Id string `json:"id"`
// ManuallyAddedSeconds The number of seconds spent reading that was manually input by the user and not auto-tracked (will be included only when the type is QURAN)
ManuallyAddedSeconds *GetV1ActivityDays_200_Data_ManuallyAddedSeconds `json:"manuallyAddedSeconds,omitempty"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1ActivityDays200DataMushafId `json:"mushafId"`
// PagesRead The number of pages read on that day (will be included only when the type is QURAN)
PagesRead *GetV1ActivityDays_200_Data_PagesRead `json:"pagesRead,omitempty"`
// Progress The progress of the reading goal of that activity day (if the user has a reading goal on that day).
Progress float32 `json:"progress"`
// Ranges The ranges read on that day (will be included only when the type is QURAN)
Ranges *GetV1ActivityDays_200_Data_Ranges `json:"ranges,omitempty"`
// RemainingDailyTargetRanges The remaining range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
RemainingDailyTargetRanges *GetV1ActivityDays_200_Data_RemainingDailyTargetRanges `json:"remainingDailyTargetRanges,omitempty"`
// SecondsRead The number of seconds spent reading on that day (will be included only when the type is QURAN)
SecondsRead *GetV1ActivityDays_200_Data_SecondsRead `json:"secondsRead,omitempty"`
// Type The type of the activity day
Type GetV1ActivityDays200DataType `json:"type"`
// VersesRead The number of Ayahs read on that day (will be included only when the type is QURAN)
VersesRead *GetV1ActivityDays_200_Data_VersesRead `json:"versesRead,omitempty"`
} `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1ActivityDaysResponse ¶
func ParseGetV1ActivityDaysResponse(rsp *http.Response) (*GetV1ActivityDaysResponse, error)
ParseGetV1ActivityDaysResponse parses an HTTP response from a GetV1ActivityDaysWithResponse call
func (GetV1ActivityDaysResponse) Status ¶
func (r GetV1ActivityDaysResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1ActivityDaysResponse) StatusCode ¶
func (r GetV1ActivityDaysResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1ActivityDays_200_Data_DailyTargetPages ¶
type GetV1ActivityDays_200_Data_DailyTargetPages struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_DailyTargetRanges ¶
type GetV1ActivityDays_200_Data_DailyTargetRanges struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_DailyTargetSeconds ¶
type GetV1ActivityDays_200_Data_DailyTargetSeconds struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_ManuallyAddedSeconds ¶
type GetV1ActivityDays_200_Data_ManuallyAddedSeconds struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_PagesRead ¶
type GetV1ActivityDays_200_Data_PagesRead struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_Ranges ¶
type GetV1ActivityDays_200_Data_Ranges struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_RemainingDailyTargetRanges ¶
type GetV1ActivityDays_200_Data_RemainingDailyTargetRanges struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_SecondsRead ¶
type GetV1ActivityDays_200_Data_SecondsRead struct {
// contains filtered or unexported fields
}
type GetV1ActivityDays_200_Data_VersesRead ¶
type GetV1ActivityDays_200_Data_VersesRead struct {
// contains filtered or unexported fields
}
type GetV1BookmarksAyahsRangeParams ¶
type GetV1BookmarksAyahsRangeParams struct {
// ChapterNumber The number of the Surah that the Ayahs range belong to.
ChapterNumber int `form:"chapterNumber" json:"chapterNumber"`
// RangeStartAyahNumber The Ayah number at which the range starts.
RangeStartAyahNumber int `form:"rangeStartAyahNumber" json:"rangeStartAyahNumber"`
// RangeEndAyahNumber The Ayah number at which the range ends.
RangeEndAyahNumber int `form:"rangeEndAyahNumber" json:"rangeEndAyahNumber"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1BookmarksAyahsRangeParamsMushafId `form:"mushafId" json:"mushafId"`
}
GetV1BookmarksAyahsRangeParams defines parameters for GetV1BookmarksAyahsRange.
type GetV1BookmarksAyahsRangeParamsMushafId ¶
type GetV1BookmarksAyahsRangeParamsMushafId int
GetV1BookmarksAyahsRangeParamsMushafId defines parameters for GetV1BookmarksAyahsRange.
const ( GetV1BookmarksAyahsRangeParamsMushafIdN1 GetV1BookmarksAyahsRangeParamsMushafId = 1 GetV1BookmarksAyahsRangeParamsMushafIdN11 GetV1BookmarksAyahsRangeParamsMushafId = 11 GetV1BookmarksAyahsRangeParamsMushafIdN19 GetV1BookmarksAyahsRangeParamsMushafId = 19 GetV1BookmarksAyahsRangeParamsMushafIdN2 GetV1BookmarksAyahsRangeParamsMushafId = 2 GetV1BookmarksAyahsRangeParamsMushafIdN3 GetV1BookmarksAyahsRangeParamsMushafId = 3 GetV1BookmarksAyahsRangeParamsMushafIdN4 GetV1BookmarksAyahsRangeParamsMushafId = 4 GetV1BookmarksAyahsRangeParamsMushafIdN5 GetV1BookmarksAyahsRangeParamsMushafId = 5 GetV1BookmarksAyahsRangeParamsMushafIdN6 GetV1BookmarksAyahsRangeParamsMushafId = 6 GetV1BookmarksAyahsRangeParamsMushafIdN7 GetV1BookmarksAyahsRangeParamsMushafId = 7 )
Defines values for GetV1BookmarksAyahsRangeParamsMushafId.
type GetV1BookmarksAyahsRangeResponse ¶
type GetV1BookmarksAyahsRangeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]Bookmark `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1BookmarksAyahsRangeResponse ¶
func ParseGetV1BookmarksAyahsRangeResponse(rsp *http.Response) (*GetV1BookmarksAyahsRangeResponse, error)
ParseGetV1BookmarksAyahsRangeResponse parses an HTTP response from a GetV1BookmarksAyahsRangeWithResponse call
func (GetV1BookmarksAyahsRangeResponse) Status ¶
func (r GetV1BookmarksAyahsRangeResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1BookmarksAyahsRangeResponse) StatusCode ¶
func (r GetV1BookmarksAyahsRangeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1BookmarksBookmarkParams ¶
type GetV1BookmarksBookmarkParams struct {
// Key Surah, Juz or page number.
Key int `form:"key" json:"key"`
// Type The bookmark type.
Type *GetV1BookmarksBookmarkParamsType `form:"type,omitempty" json:"type,omitempty"`
// VerseNumber The Ayah number of the bookmark
VerseNumber *int `form:"verseNumber,omitempty" json:"verseNumber,omitempty"`
// Mushaf The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
Mushaf GetV1BookmarksBookmarkParamsMushaf `form:"mushaf" json:"mushaf"`
}
GetV1BookmarksBookmarkParams defines parameters for GetV1BookmarksBookmark.
type GetV1BookmarksBookmarkParamsMushaf ¶
type GetV1BookmarksBookmarkParamsMushaf int
GetV1BookmarksBookmarkParamsMushaf defines parameters for GetV1BookmarksBookmark.
const ( GetV1BookmarksBookmarkParamsMushafN1 GetV1BookmarksBookmarkParamsMushaf = 1 GetV1BookmarksBookmarkParamsMushafN11 GetV1BookmarksBookmarkParamsMushaf = 11 GetV1BookmarksBookmarkParamsMushafN19 GetV1BookmarksBookmarkParamsMushaf = 19 GetV1BookmarksBookmarkParamsMushafN2 GetV1BookmarksBookmarkParamsMushaf = 2 GetV1BookmarksBookmarkParamsMushafN3 GetV1BookmarksBookmarkParamsMushaf = 3 GetV1BookmarksBookmarkParamsMushafN4 GetV1BookmarksBookmarkParamsMushaf = 4 GetV1BookmarksBookmarkParamsMushafN5 GetV1BookmarksBookmarkParamsMushaf = 5 GetV1BookmarksBookmarkParamsMushafN6 GetV1BookmarksBookmarkParamsMushaf = 6 GetV1BookmarksBookmarkParamsMushafN7 GetV1BookmarksBookmarkParamsMushaf = 7 )
Defines values for GetV1BookmarksBookmarkParamsMushaf.
type GetV1BookmarksBookmarkParamsType ¶
type GetV1BookmarksBookmarkParamsType string
GetV1BookmarksBookmarkParamsType defines parameters for GetV1BookmarksBookmark.
const ( GetV1BookmarksBookmarkParamsTypeAyah GetV1BookmarksBookmarkParamsType = "ayah" GetV1BookmarksBookmarkParamsTypeJuz GetV1BookmarksBookmarkParamsType = "juz" GetV1BookmarksBookmarkParamsTypePage GetV1BookmarksBookmarkParamsType = "page" GetV1BookmarksBookmarkParamsTypeSurah GetV1BookmarksBookmarkParamsType = "surah" )
Defines values for GetV1BookmarksBookmarkParamsType.
type GetV1BookmarksBookmarkResponse ¶
type GetV1BookmarksBookmarkResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Bookmark `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1BookmarksBookmarkResponse ¶
func ParseGetV1BookmarksBookmarkResponse(rsp *http.Response) (*GetV1BookmarksBookmarkResponse, error)
ParseGetV1BookmarksBookmarkResponse parses an HTTP response from a GetV1BookmarksBookmarkWithResponse call
func (GetV1BookmarksBookmarkResponse) Status ¶
func (r GetV1BookmarksBookmarkResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1BookmarksBookmarkResponse) StatusCode ¶
func (r GetV1BookmarksBookmarkResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1BookmarksCollectionsParams ¶
type GetV1BookmarksCollectionsParams struct {
// Key Surah, Juz or page number.
Key float32 `form:"key" json:"key"`
// Type The bookmark type.
Type *GetV1BookmarksCollectionsParamsType `form:"type,omitempty" json:"type,omitempty"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1BookmarksCollectionsParamsMushafId `form:"mushafId" json:"mushafId"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1BookmarksCollectionsParams defines parameters for GetV1BookmarksCollections.
type GetV1BookmarksCollectionsParamsMushafId ¶
type GetV1BookmarksCollectionsParamsMushafId int
GetV1BookmarksCollectionsParamsMushafId defines parameters for GetV1BookmarksCollections.
const ( GetV1BookmarksCollectionsParamsMushafIdN1 GetV1BookmarksCollectionsParamsMushafId = 1 GetV1BookmarksCollectionsParamsMushafIdN11 GetV1BookmarksCollectionsParamsMushafId = 11 GetV1BookmarksCollectionsParamsMushafIdN19 GetV1BookmarksCollectionsParamsMushafId = 19 GetV1BookmarksCollectionsParamsMushafIdN2 GetV1BookmarksCollectionsParamsMushafId = 2 GetV1BookmarksCollectionsParamsMushafIdN3 GetV1BookmarksCollectionsParamsMushafId = 3 GetV1BookmarksCollectionsParamsMushafIdN4 GetV1BookmarksCollectionsParamsMushafId = 4 GetV1BookmarksCollectionsParamsMushafIdN5 GetV1BookmarksCollectionsParamsMushafId = 5 GetV1BookmarksCollectionsParamsMushafIdN6 GetV1BookmarksCollectionsParamsMushafId = 6 GetV1BookmarksCollectionsParamsMushafIdN7 GetV1BookmarksCollectionsParamsMushafId = 7 )
Defines values for GetV1BookmarksCollectionsParamsMushafId.
type GetV1BookmarksCollectionsParamsType ¶
type GetV1BookmarksCollectionsParamsType string
GetV1BookmarksCollectionsParamsType defines parameters for GetV1BookmarksCollections.
const ( GetV1BookmarksCollectionsParamsTypeAyah GetV1BookmarksCollectionsParamsType = "ayah" GetV1BookmarksCollectionsParamsTypeJuz GetV1BookmarksCollectionsParamsType = "juz" GetV1BookmarksCollectionsParamsTypePage GetV1BookmarksCollectionsParamsType = "page" GetV1BookmarksCollectionsParamsTypeSurah GetV1BookmarksCollectionsParamsType = "surah" )
Defines values for GetV1BookmarksCollectionsParamsType.
type GetV1BookmarksCollectionsResponse ¶
type GetV1BookmarksCollectionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]Collection `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1BookmarksCollectionsResponse ¶
func ParseGetV1BookmarksCollectionsResponse(rsp *http.Response) (*GetV1BookmarksCollectionsResponse, error)
ParseGetV1BookmarksCollectionsResponse parses an HTTP response from a GetV1BookmarksCollectionsWithResponse call
func (GetV1BookmarksCollectionsResponse) Status ¶
func (r GetV1BookmarksCollectionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1BookmarksCollectionsResponse) StatusCode ¶
func (r GetV1BookmarksCollectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1BookmarksParams ¶
type GetV1BookmarksParams struct {
// Type The bookmark type.
Type *GetV1BookmarksParamsType `form:"type,omitempty" json:"type,omitempty"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1BookmarksParamsMushafId `form:"mushafId" json:"mushafId"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1BookmarksParams defines parameters for GetV1Bookmarks.
type GetV1BookmarksParamsMushafId ¶
type GetV1BookmarksParamsMushafId int
GetV1BookmarksParamsMushafId defines parameters for GetV1Bookmarks.
const ( GetV1BookmarksParamsMushafIdN1 GetV1BookmarksParamsMushafId = 1 GetV1BookmarksParamsMushafIdN11 GetV1BookmarksParamsMushafId = 11 GetV1BookmarksParamsMushafIdN19 GetV1BookmarksParamsMushafId = 19 GetV1BookmarksParamsMushafIdN2 GetV1BookmarksParamsMushafId = 2 GetV1BookmarksParamsMushafIdN3 GetV1BookmarksParamsMushafId = 3 GetV1BookmarksParamsMushafIdN4 GetV1BookmarksParamsMushafId = 4 GetV1BookmarksParamsMushafIdN5 GetV1BookmarksParamsMushafId = 5 GetV1BookmarksParamsMushafIdN6 GetV1BookmarksParamsMushafId = 6 GetV1BookmarksParamsMushafIdN7 GetV1BookmarksParamsMushafId = 7 )
Defines values for GetV1BookmarksParamsMushafId.
type GetV1BookmarksParamsType ¶
type GetV1BookmarksParamsType string
GetV1BookmarksParamsType defines parameters for GetV1Bookmarks.
const ( GetV1BookmarksParamsTypeAyah GetV1BookmarksParamsType = "ayah" GetV1BookmarksParamsTypeJuz GetV1BookmarksParamsType = "juz" GetV1BookmarksParamsTypePage GetV1BookmarksParamsType = "page" GetV1BookmarksParamsTypeSurah GetV1BookmarksParamsType = "surah" )
Defines values for GetV1BookmarksParamsType.
type GetV1BookmarksResponse ¶
type GetV1BookmarksResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]Bookmark `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1BookmarksResponse ¶
func ParseGetV1BookmarksResponse(rsp *http.Response) (*GetV1BookmarksResponse, error)
ParseGetV1BookmarksResponse parses an HTTP response from a GetV1BookmarksWithResponse call
func (GetV1BookmarksResponse) Status ¶
func (r GetV1BookmarksResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1BookmarksResponse) StatusCode ¶
func (r GetV1BookmarksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1CollectionsAllParams ¶
type GetV1CollectionsAllParams struct {
// SortBy Sort the collection items either by the time they were added at descendingly or alphabetically.
SortBy *GetV1CollectionsAllParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1CollectionsAllParams defines parameters for GetV1CollectionsAll.
type GetV1CollectionsAllParamsSortBy ¶
type GetV1CollectionsAllParamsSortBy string
GetV1CollectionsAllParamsSortBy defines parameters for GetV1CollectionsAll.
const ( GetV1CollectionsAllParamsSortByRecentlyAdded GetV1CollectionsAllParamsSortBy = "recentlyAdded" GetV1CollectionsAllParamsSortByVerseKey GetV1CollectionsAllParamsSortBy = "verseKey" )
Defines values for GetV1CollectionsAllParamsSortBy.
type GetV1CollectionsAllResponse ¶
type GetV1CollectionsAllResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]Bookmark `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1CollectionsAllResponse ¶
func ParseGetV1CollectionsAllResponse(rsp *http.Response) (*GetV1CollectionsAllResponse, error)
ParseGetV1CollectionsAllResponse parses an HTTP response from a GetV1CollectionsAllWithResponse call
func (GetV1CollectionsAllResponse) Status ¶
func (r GetV1CollectionsAllResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1CollectionsAllResponse) StatusCode ¶
func (r GetV1CollectionsAllResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1CollectionsCollectionIdParams ¶
type GetV1CollectionsCollectionIdParams struct {
// SortBy Sort the collection items either by the time they were added at descendingly or by Ayah key.
SortBy *GetV1CollectionsCollectionIdParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1CollectionsCollectionIdParams defines parameters for GetV1CollectionsCollectionId.
type GetV1CollectionsCollectionIdParamsSortBy ¶
type GetV1CollectionsCollectionIdParamsSortBy string
GetV1CollectionsCollectionIdParamsSortBy defines parameters for GetV1CollectionsCollectionId.
const ( GetV1CollectionsCollectionIdParamsSortByRecentlyAdded GetV1CollectionsCollectionIdParamsSortBy = "recentlyAdded" GetV1CollectionsCollectionIdParamsSortByVerseKey GetV1CollectionsCollectionIdParamsSortBy = "verseKey" )
Defines values for GetV1CollectionsCollectionIdParamsSortBy.
type GetV1CollectionsCollectionIdResponse ¶
type GetV1CollectionsCollectionIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Bookmarks *[]Bookmark `json:"bookmarks,omitempty"`
Collection *Collection `json:"collection,omitempty"`
} `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1CollectionsCollectionIdResponse ¶
func ParseGetV1CollectionsCollectionIdResponse(rsp *http.Response) (*GetV1CollectionsCollectionIdResponse, error)
ParseGetV1CollectionsCollectionIdResponse parses an HTTP response from a GetV1CollectionsCollectionIdWithResponse call
func (GetV1CollectionsCollectionIdResponse) Status ¶
func (r GetV1CollectionsCollectionIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1CollectionsCollectionIdResponse) StatusCode ¶
func (r GetV1CollectionsCollectionIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1CollectionsParams ¶
type GetV1CollectionsParams struct {
// SortBy Sort the collections list either by the time they were updated at descendingly or alphabetically.
SortBy *GetV1CollectionsParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1CollectionsParams defines parameters for GetV1Collections.
type GetV1CollectionsParamsSortBy ¶
type GetV1CollectionsParamsSortBy string
GetV1CollectionsParamsSortBy defines parameters for GetV1Collections.
const ( Alphabetical GetV1CollectionsParamsSortBy = "alphabetical" RecentlyUpdated GetV1CollectionsParamsSortBy = "recentlyUpdated" )
Defines values for GetV1CollectionsParamsSortBy.
type GetV1CollectionsResponse ¶
type GetV1CollectionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]Collection `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1CollectionsResponse ¶
func ParseGetV1CollectionsResponse(rsp *http.Response) (*GetV1CollectionsResponse, error)
ParseGetV1CollectionsResponse parses an HTTP response from a GetV1CollectionsWithResponse call
func (GetV1CollectionsResponse) Status ¶
func (r GetV1CollectionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1CollectionsResponse) StatusCode ¶
func (r GetV1CollectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1GoalsEstimateParams ¶
type GetV1GoalsEstimateParams struct {
// Type The type of the goal.
Type GetV1GoalsEstimateParamsType `form:"type" json:"type"`
// Amount The amount of the goal. Depending on the goal type, the amount value and format will be different
Amount struct {
// contains filtered or unexported fields
} `form:"amount" json:"amount"`
// Duration The duration of the goal in days. If it's empty it means the goal is a daily goal and not duration-based.
Duration *int `form:"duration,omitempty" json:"duration,omitempty"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1GoalsEstimateParamsMushafId `form:"mushafId" json:"mushafId"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
GetV1GoalsEstimateParams defines parameters for GetV1GoalsEstimate.
type GetV1GoalsEstimateParamsAmount0 ¶
type GetV1GoalsEstimateParamsAmount0 = string
GetV1GoalsEstimateParamsAmount0 defines parameters for GetV1GoalsEstimate.
type GetV1GoalsEstimateParamsAmount1 ¶
type GetV1GoalsEstimateParamsAmount1 = int
GetV1GoalsEstimateParamsAmount1 defines parameters for GetV1GoalsEstimate.
type GetV1GoalsEstimateParamsMushafId ¶
type GetV1GoalsEstimateParamsMushafId int
GetV1GoalsEstimateParamsMushafId defines parameters for GetV1GoalsEstimate.
const ( GetV1GoalsEstimateParamsMushafIdN1 GetV1GoalsEstimateParamsMushafId = 1 GetV1GoalsEstimateParamsMushafIdN11 GetV1GoalsEstimateParamsMushafId = 11 GetV1GoalsEstimateParamsMushafIdN19 GetV1GoalsEstimateParamsMushafId = 19 GetV1GoalsEstimateParamsMushafIdN2 GetV1GoalsEstimateParamsMushafId = 2 GetV1GoalsEstimateParamsMushafIdN3 GetV1GoalsEstimateParamsMushafId = 3 GetV1GoalsEstimateParamsMushafIdN4 GetV1GoalsEstimateParamsMushafId = 4 GetV1GoalsEstimateParamsMushafIdN5 GetV1GoalsEstimateParamsMushafId = 5 GetV1GoalsEstimateParamsMushafIdN6 GetV1GoalsEstimateParamsMushafId = 6 GetV1GoalsEstimateParamsMushafIdN7 GetV1GoalsEstimateParamsMushafId = 7 )
Defines values for GetV1GoalsEstimateParamsMushafId.
type GetV1GoalsEstimateParamsType ¶
type GetV1GoalsEstimateParamsType string
GetV1GoalsEstimateParamsType defines parameters for GetV1GoalsEstimate.
const ( GetV1GoalsEstimateParamsTypeCOURSE GetV1GoalsEstimateParamsType = "COURSE" GetV1GoalsEstimateParamsTypeQURANPAGES GetV1GoalsEstimateParamsType = "QURAN_PAGES" GetV1GoalsEstimateParamsTypeQURANRANGE GetV1GoalsEstimateParamsType = "QURAN_RANGE" GetV1GoalsEstimateParamsTypeQURANREADINGPROGRAM GetV1GoalsEstimateParamsType = "QURAN_READING_PROGRAM" GetV1GoalsEstimateParamsTypeQURANTIME GetV1GoalsEstimateParamsType = "QURAN_TIME" )
Defines values for GetV1GoalsEstimateParamsType.
type GetV1GoalsEstimateResponse ¶
type GetV1GoalsEstimateResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *EstimatedGoalTimeline `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1GoalsEstimateResponse ¶
func ParseGetV1GoalsEstimateResponse(rsp *http.Response) (*GetV1GoalsEstimateResponse, error)
ParseGetV1GoalsEstimateResponse parses an HTTP response from a GetV1GoalsEstimateWithResponse call
func (GetV1GoalsEstimateResponse) Status ¶
func (r GetV1GoalsEstimateResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1GoalsEstimateResponse) StatusCode ¶
func (r GetV1GoalsEstimateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1GoalsGetTodaysPlan200Data0 ¶
type GetV1GoalsGetTodaysPlan200Data0 struct {
// DailyTargetPages The number of pages user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetPages *GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetPages `json:"dailyTargetPages,omitempty"`
// DailyTargetRanges The range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetRanges *GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetRanges `json:"dailyTargetRanges,omitempty"`
// DailyTargetSeconds The number of seconds user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
DailyTargetSeconds *GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetSeconds `json:"dailyTargetSeconds,omitempty"`
// Date The date of the activity day.
Date string `json:"date"`
// Id The id of the activity day.
Id string `json:"id"`
// ManuallyAddedSeconds The number of seconds spent reading that was manually input by the user and not auto-tracked (will be included only when the type is QURAN)
ManuallyAddedSeconds *GetV1GoalsGetTodaysPlan_200_Data_0_ManuallyAddedSeconds `json:"manuallyAddedSeconds,omitempty"`
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId GetV1GoalsGetTodaysPlan200Data0MushafId `json:"mushafId"`
// PagesRead The number of pages read on that day (will be included only when the type is QURAN)
PagesRead *GetV1GoalsGetTodaysPlan_200_Data_0_PagesRead `json:"pagesRead,omitempty"`
// Progress The progress of the reading goal of that activity day (if the user has a reading goal on that day).
Progress float32 `json:"progress"`
// Ranges The ranges read on that day (will be included only when the type is QURAN)
Ranges *GetV1GoalsGetTodaysPlan_200_Data_0_Ranges `json:"ranges,omitempty"`
// RemainingDailyTargetRanges The remaining range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
RemainingDailyTargetRanges *GetV1GoalsGetTodaysPlan_200_Data_0_RemainingDailyTargetRanges `json:"remainingDailyTargetRanges,omitempty"`
// SecondsRead The number of seconds spent reading on that day (will be included only when the type is QURAN)
SecondsRead *GetV1GoalsGetTodaysPlan_200_Data_0_SecondsRead `json:"secondsRead,omitempty"`
// Type The type of the activity day
Type GetV1GoalsGetTodaysPlan200Data0Type `json:"type"`
// VersesRead The number of Ayahs read on that day (will be included only when the type is QURAN)
VersesRead *GetV1GoalsGetTodaysPlan_200_Data_0_VersesRead `json:"versesRead,omitempty"`
}
type GetV1GoalsGetTodaysPlan200Data0DailyTargetPages0 ¶
type GetV1GoalsGetTodaysPlan200Data0DailyTargetPages0 = float32
type GetV1GoalsGetTodaysPlan200Data0DailyTargetRanges0 ¶
type GetV1GoalsGetTodaysPlan200Data0DailyTargetRanges0 = []string
type GetV1GoalsGetTodaysPlan200Data0DailyTargetSeconds0 ¶
type GetV1GoalsGetTodaysPlan200Data0DailyTargetSeconds0 = int
type GetV1GoalsGetTodaysPlan200Data0ManuallyAddedSeconds0 ¶
type GetV1GoalsGetTodaysPlan200Data0ManuallyAddedSeconds0 = int
type GetV1GoalsGetTodaysPlan200Data0MushafId ¶
type GetV1GoalsGetTodaysPlan200Data0MushafId int
type GetV1GoalsGetTodaysPlan200Data0PagesRead0 ¶
type GetV1GoalsGetTodaysPlan200Data0PagesRead0 = float32
type GetV1GoalsGetTodaysPlan200Data0Ranges0 ¶
type GetV1GoalsGetTodaysPlan200Data0Ranges0 = []string
type GetV1GoalsGetTodaysPlan200Data0RemainingDailyTargetRanges0 ¶
type GetV1GoalsGetTodaysPlan200Data0RemainingDailyTargetRanges0 = []string
type GetV1GoalsGetTodaysPlan200Data0SecondsRead0 ¶
type GetV1GoalsGetTodaysPlan200Data0SecondsRead0 = int
type GetV1GoalsGetTodaysPlan200Data0Type ¶
type GetV1GoalsGetTodaysPlan200Data0Type string
type GetV1GoalsGetTodaysPlan200Data0VersesRead0 ¶
type GetV1GoalsGetTodaysPlan200Data0VersesRead0 = int
type GetV1GoalsGetTodaysPlanParams ¶
type GetV1GoalsGetTodaysPlanParams struct {
// Type The type of the goal.
Type GetV1GoalsGetTodaysPlanParamsType `form:"type" json:"type"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
GetV1GoalsGetTodaysPlanParams defines parameters for GetV1GoalsGetTodaysPlan.
type GetV1GoalsGetTodaysPlanParamsType ¶
type GetV1GoalsGetTodaysPlanParamsType string
GetV1GoalsGetTodaysPlanParamsType defines parameters for GetV1GoalsGetTodaysPlan.
const ( GetV1GoalsGetTodaysPlanParamsTypeCOURSE GetV1GoalsGetTodaysPlanParamsType = "COURSE" GetV1GoalsGetTodaysPlanParamsTypeQURANPAGES GetV1GoalsGetTodaysPlanParamsType = "QURAN_PAGES" GetV1GoalsGetTodaysPlanParamsTypeQURANRANGE GetV1GoalsGetTodaysPlanParamsType = "QURAN_RANGE" GetV1GoalsGetTodaysPlanParamsTypeQURANREADINGPROGRAM GetV1GoalsGetTodaysPlanParamsType = "QURAN_READING_PROGRAM" GetV1GoalsGetTodaysPlanParamsTypeQURANTIME GetV1GoalsGetTodaysPlanParamsType = "QURAN_TIME" )
Defines values for GetV1GoalsGetTodaysPlanParamsType.
type GetV1GoalsGetTodaysPlanResponse ¶
type GetV1GoalsGetTodaysPlanResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *GetV1GoalsGetTodaysPlan_200_Data `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1GoalsGetTodaysPlanResponse ¶
func ParseGetV1GoalsGetTodaysPlanResponse(rsp *http.Response) (*GetV1GoalsGetTodaysPlanResponse, error)
ParseGetV1GoalsGetTodaysPlanResponse parses an HTTP response from a GetV1GoalsGetTodaysPlanWithResponse call
func (GetV1GoalsGetTodaysPlanResponse) Status ¶
func (r GetV1GoalsGetTodaysPlanResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1GoalsGetTodaysPlanResponse) StatusCode ¶
func (r GetV1GoalsGetTodaysPlanResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1GoalsGetTodaysPlan_200_Data ¶
type GetV1GoalsGetTodaysPlan_200_Data struct {
// HasGoal User has a goal.
HasGoal bool `json:"hasGoal"`
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetPages ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetPages struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetRanges ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetRanges struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetSeconds ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_DailyTargetSeconds struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_ManuallyAddedSeconds ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_ManuallyAddedSeconds struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_PagesRead ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_PagesRead struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_Ranges ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_Ranges struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_RemainingDailyTargetRanges ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_RemainingDailyTargetRanges struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_SecondsRead ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_SecondsRead struct {
// contains filtered or unexported fields
}
type GetV1GoalsGetTodaysPlan_200_Data_0_VersesRead ¶
type GetV1GoalsGetTodaysPlan_200_Data_0_VersesRead struct {
// contains filtered or unexported fields
}
type GetV1GroupsGroupIdResponse ¶
type GetV1GroupsGroupIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Room `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1GroupsGroupIdResponse ¶
func ParseGetV1GroupsGroupIdResponse(rsp *http.Response) (*GetV1GroupsGroupIdResponse, error)
ParseGetV1GroupsGroupIdResponse parses an HTTP response from a GetV1GroupsGroupIdWithResponse call
func (GetV1GroupsGroupIdResponse) Status ¶
func (r GetV1GroupsGroupIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1GroupsGroupIdResponse) StatusCode ¶
func (r GetV1GroupsGroupIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1GroupsResponse ¶
type GetV1GroupsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Groups List of user groups.
Groups *[]Room `json:"groups,omitempty"`
// Pages List of user pages.
Pages *[]Room `json:"pages,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1GroupsResponse ¶
func ParseGetV1GroupsResponse(rsp *http.Response) (*GetV1GroupsResponse, error)
ParseGetV1GroupsResponse parses an HTTP response from a GetV1GroupsWithResponse call
func (GetV1GroupsResponse) Status ¶
func (r GetV1GroupsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1GroupsResponse) StatusCode ¶
func (r GetV1GroupsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1Notes200DataAttachedEntitiesEntityType ¶
type GetV1Notes200DataAttachedEntitiesEntityType string
type GetV1NotesByAttachedEntity200DataAttachedEntitiesEntityType ¶
type GetV1NotesByAttachedEntity200DataAttachedEntitiesEntityType string
type GetV1NotesByAttachedEntityParams ¶
type GetV1NotesByAttachedEntityParams struct {
// EntityId The unique identifier for the attached entity.
EntityId string `form:"entityId" json:"entityId"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1NotesByAttachedEntityParamsEntityType `form:"entityType" json:"entityType"`
}
GetV1NotesByAttachedEntityParams defines parameters for GetV1NotesByAttachedEntity.
type GetV1NotesByAttachedEntityParamsEntityType ¶
type GetV1NotesByAttachedEntityParamsEntityType string
GetV1NotesByAttachedEntityParamsEntityType defines parameters for GetV1NotesByAttachedEntity.
const (
GetV1NotesByAttachedEntityParamsEntityTypeReflection GetV1NotesByAttachedEntityParamsEntityType = "reflection"
)
Defines values for GetV1NotesByAttachedEntityParamsEntityType.
type GetV1NotesByAttachedEntityResponse ¶
type GetV1NotesByAttachedEntityResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1NotesByAttachedEntity200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesByAttachedEntityResponse ¶
func ParseGetV1NotesByAttachedEntityResponse(rsp *http.Response) (*GetV1NotesByAttachedEntityResponse, error)
ParseGetV1NotesByAttachedEntityResponse parses an HTTP response from a GetV1NotesByAttachedEntityWithResponse call
func (GetV1NotesByAttachedEntityResponse) Status ¶
func (r GetV1NotesByAttachedEntityResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesByAttachedEntityResponse) StatusCode ¶
func (r GetV1NotesByAttachedEntityResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1NotesByRange200DataAttachedEntitiesEntityType ¶
type GetV1NotesByRange200DataAttachedEntitiesEntityType string
type GetV1NotesByRangeParams ¶
type GetV1NotesByRangeParams struct {
// From The starting verse key of the range.
From string `form:"from" json:"from"`
// To The ending verse key of the range.
To string `form:"to" json:"to"`
}
GetV1NotesByRangeParams defines parameters for GetV1NotesByRange.
type GetV1NotesByRangeResponse ¶
type GetV1NotesByRangeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1NotesByRange200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesByRangeResponse ¶
func ParseGetV1NotesByRangeResponse(rsp *http.Response) (*GetV1NotesByRangeResponse, error)
ParseGetV1NotesByRangeResponse parses an HTTP response from a GetV1NotesByRangeWithResponse call
func (GetV1NotesByRangeResponse) Status ¶
func (r GetV1NotesByRangeResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesByRangeResponse) StatusCode ¶
func (r GetV1NotesByRangeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1NotesByVerseVerseKey200DataAttachedEntitiesEntityType ¶
type GetV1NotesByVerseVerseKey200DataAttachedEntitiesEntityType string
type GetV1NotesByVerseVerseKeyResponse ¶
type GetV1NotesByVerseVerseKeyResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1NotesByVerseVerseKey200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesByVerseVerseKeyResponse ¶
func ParseGetV1NotesByVerseVerseKeyResponse(rsp *http.Response) (*GetV1NotesByVerseVerseKeyResponse, error)
ParseGetV1NotesByVerseVerseKeyResponse parses an HTTP response from a GetV1NotesByVerseVerseKeyWithResponse call
func (GetV1NotesByVerseVerseKeyResponse) Status ¶
func (r GetV1NotesByVerseVerseKeyResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesByVerseVerseKeyResponse) StatusCode ¶
func (r GetV1NotesByVerseVerseKeyResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1NotesCountWithinRangeParams ¶
type GetV1NotesCountWithinRangeParams struct {
// From The starting verse key of the range.
From string `form:"from" json:"from"`
// To The ending verse key of the range.
To string `form:"to" json:"to"`
}
GetV1NotesCountWithinRangeParams defines parameters for GetV1NotesCountWithinRange.
type GetV1NotesCountWithinRangeResponse ¶
type GetV1NotesCountWithinRangeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
// Data A map of verse keys to note counts, where each key is a verse key and each value is an integer count of notes.
Data *map[string]int `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesCountWithinRangeResponse ¶
func ParseGetV1NotesCountWithinRangeResponse(rsp *http.Response) (*GetV1NotesCountWithinRangeResponse, error)
ParseGetV1NotesCountWithinRangeResponse parses an HTTP response from a GetV1NotesCountWithinRangeWithResponse call
func (GetV1NotesCountWithinRangeResponse) Status ¶
func (r GetV1NotesCountWithinRangeResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesCountWithinRangeResponse) StatusCode ¶
func (r GetV1NotesCountWithinRangeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1NotesNoteId200DataAttachedEntitiesEntityType ¶
type GetV1NotesNoteId200DataAttachedEntitiesEntityType string
type GetV1NotesNoteIdParams ¶
type GetV1NotesNoteIdParams struct {
// WithAttachedEntities Specifies whether to include attached entities in the response, defaults to true.
WithAttachedEntities *bool `form:"withAttachedEntities,omitempty" json:"withAttachedEntities,omitempty"`
}
GetV1NotesNoteIdParams defines parameters for GetV1NotesNoteId.
type GetV1NotesNoteIdResponse ¶
type GetV1NotesNoteIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1NotesNoteId200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesNoteIdResponse ¶
func ParseGetV1NotesNoteIdResponse(rsp *http.Response) (*GetV1NotesNoteIdResponse, error)
ParseGetV1NotesNoteIdResponse parses an HTTP response from a GetV1NotesNoteIdWithResponse call
func (GetV1NotesNoteIdResponse) Status ¶
func (r GetV1NotesNoteIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesNoteIdResponse) StatusCode ¶
func (r GetV1NotesNoteIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1NotesParams ¶
type GetV1NotesParams struct {
// Cursor A cursor for pagination, used to fetch the next set of results.
Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
// Limit The maximum number of notes to return, defaults to 20.
Limit *float32 `form:"limit,omitempty" json:"limit,omitempty"`
// SortBy The sorting order of the notes, defaults to newest first.
SortBy *GetV1NotesParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
}
GetV1NotesParams defines parameters for GetV1Notes.
type GetV1NotesParamsSortBy ¶
type GetV1NotesParamsSortBy string
GetV1NotesParamsSortBy defines parameters for GetV1Notes.
const ( GetV1NotesParamsSortByNewest GetV1NotesParamsSortBy = "newest" GetV1NotesParamsSortByOldest GetV1NotesParamsSortBy = "oldest" )
Defines values for GetV1NotesParamsSortBy.
type GetV1NotesResponse ¶
type GetV1NotesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType GetV1Notes200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1NotesResponse ¶
func ParseGetV1NotesResponse(rsp *http.Response) (*GetV1NotesResponse, error)
ParseGetV1NotesResponse parses an HTTP response from a GetV1NotesWithResponse call
func (GetV1NotesResponse) Status ¶
func (r GetV1NotesResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1NotesResponse) StatusCode ¶
func (r GetV1NotesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1PostsParams ¶
type GetV1PostsParams struct {
// ExactAyah Get posts of an exact Ayah only and not of range of Ayahs (the default behavior).
ExactAyah *bool `form:"exactAyah,omitempty" json:"exactAyah,omitempty"`
// Languages Comma-separated language iso codes, to fetch posts in a specific language(s).
Languages *string `form:"languages,omitempty" json:"languages,omitempty"`
// ScholarsPosts Include posts of scholars
ScholarsPosts *bool `form:"scholarsPosts,omitempty" json:"scholarsPosts,omitempty"`
// AuthorIds The Ids of the authors of the posts
AuthorIds *[]int `form:"authorIds,omitempty" json:"authorIds,omitempty"`
// StudentsOfKnowledgePosts Include posts of students of knowledge
StudentsOfKnowledgePosts *bool `form:"studentsOfKnowledgePosts,omitempty" json:"studentsOfKnowledgePosts,omitempty"`
// Verified Include verified posts
Verified *bool `form:"verified,omitempty" json:"verified,omitempty"`
// Approved Include approved posts
Approved *bool `form:"approved,omitempty" json:"approved,omitempty"`
// UpdatedSince Get posts that are updated after the given date (inclusive).
UpdatedSince *string `form:"updatedSince,omitempty" json:"updatedSince,omitempty"`
// Filters Further customize the results, you can fetch posts of specific members, post that have specific tags, post for specific surah, ayah range or single ayah etc.
Filters *struct {
// PostTypeIds The Ids of the types the post is attached to
PostTypeIds *[]int `json:"postTypeIds,omitempty"`
// References The Surahs/Ayahs the post relates to.
References *[]PostReference `json:"references,omitempty"`
// ReferencesOperation **`OR`** = Will get posts that match **any** of the passed filters
//
// **`AND`** = Will get posts that match **all** of the passed filters
ReferencesOperation *GetV1PostsParamsFiltersReferencesOperation `json:"referencesOperation,omitempty"`
// TagIds The Ids of the tags the post is attached to
TagIds *[]int `json:"tagIds,omitempty"`
// TagsOperation **`OR`** = Will get posts that match **any** of the passed filters
//
// **`AND`** = Will get posts that match **all** of the passed filters
TagsOperation *GetV1PostsParamsFiltersTagsOperation `json:"tagsOperation,omitempty"`
} `form:"filters,omitempty" json:"filters,omitempty"`
// Tab **`newest`** = Recent posts will be at the top.
//
// **`following`** = Get posts of authors the current user is following.
//
// **`draft`** = Get current user's private posts.
//
// **`favorite`** = Get current user's favorite posts.
//
// **`most_popular`** = Get most popular posts.
//
// **`only_room_members`** = Get posts that are posted by current room members.
//
// **`public`** = Include public posts of private rooms.
//
// **`feed`** = When passed, this will ignore most passed filters and send `verified` posts (if `verified` = `true`), posts by scholars and student of knowledge, verified posts, posts from author the user is following.
Tab *GetV1PostsParamsTab `form:"tab,omitempty" json:"tab,omitempty"`
// Feed Include only trusted posts and posts by author the user is following.
Feed *bool `form:"feed,omitempty" json:"feed,omitempty"`
// Page The current post page. Each page will have 25 posts by default. `pages` response field will have the total number of pages.
Page *int `form:"page,omitempty" json:"page,omitempty"`
}
GetV1PostsParams defines parameters for GetV1Posts.
type GetV1PostsParamsFiltersReferencesOperation ¶
type GetV1PostsParamsFiltersReferencesOperation string
GetV1PostsParamsFiltersReferencesOperation defines parameters for GetV1Posts.
const ( GetV1PostsParamsFiltersReferencesOperationAND GetV1PostsParamsFiltersReferencesOperation = "AND" GetV1PostsParamsFiltersReferencesOperationOR GetV1PostsParamsFiltersReferencesOperation = "OR" )
Defines values for GetV1PostsParamsFiltersReferencesOperation.
type GetV1PostsParamsFiltersTagsOperation ¶
type GetV1PostsParamsFiltersTagsOperation string
GetV1PostsParamsFiltersTagsOperation defines parameters for GetV1Posts.
const ( GetV1PostsParamsFiltersTagsOperationAND GetV1PostsParamsFiltersTagsOperation = "AND" GetV1PostsParamsFiltersTagsOperationOR GetV1PostsParamsFiltersTagsOperation = "OR" )
Defines values for GetV1PostsParamsFiltersTagsOperation.
type GetV1PostsParamsTab ¶
type GetV1PostsParamsTab string
GetV1PostsParamsTab defines parameters for GetV1Posts.
const ( GetV1PostsParamsTabDraft GetV1PostsParamsTab = "draft" GetV1PostsParamsTabFavorite GetV1PostsParamsTab = "favorite" GetV1PostsParamsTabFeed GetV1PostsParamsTab = "feed" GetV1PostsParamsTabFollowing GetV1PostsParamsTab = "following" GetV1PostsParamsTabMostPopular GetV1PostsParamsTab = "most_popular" GetV1PostsParamsTabNewest GetV1PostsParamsTab = "newest" GetV1PostsParamsTabOnlyRoomMembers GetV1PostsParamsTab = "only_room_members" GetV1PostsParamsTabPublic GetV1PostsParamsTab = "public" )
Defines values for GetV1PostsParamsTab.
type GetV1PostsPostIdCommentsResponse ¶
type GetV1PostsPostIdCommentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Comments List of comments that belong to the post.
Comments *[]Comment `json:"comments,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1PostsPostIdCommentsResponse ¶
func ParseGetV1PostsPostIdCommentsResponse(rsp *http.Response) (*GetV1PostsPostIdCommentsResponse, error)
ParseGetV1PostsPostIdCommentsResponse parses an HTTP response from a GetV1PostsPostIdCommentsWithResponse call
func (GetV1PostsPostIdCommentsResponse) Status ¶
func (r GetV1PostsPostIdCommentsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1PostsPostIdCommentsResponse) StatusCode ¶
func (r GetV1PostsPostIdCommentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1PostsPostIdResponse ¶
type GetV1PostsPostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Post `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1PostsPostIdResponse ¶
func ParseGetV1PostsPostIdResponse(rsp *http.Response) (*GetV1PostsPostIdResponse, error)
ParseGetV1PostsPostIdResponse parses an HTTP response from a GetV1PostsPostIdWithResponse call
func (GetV1PostsPostIdResponse) Status ¶
func (r GetV1PostsPostIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1PostsPostIdResponse) StatusCode ¶
func (r GetV1PostsPostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1PostsResponse ¶
type GetV1PostsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Pages Number of pages matching the queried posts
Pages *int `json:"pages,omitempty"`
// Posts List of posts
Posts *[]Post `json:"posts,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1PostsResponse ¶
func ParseGetV1PostsResponse(rsp *http.Response) (*GetV1PostsResponse, error)
ParseGetV1PostsResponse parses an HTTP response from a GetV1PostsWithResponse call
func (GetV1PostsResponse) Status ¶
func (r GetV1PostsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1PostsResponse) StatusCode ¶
func (r GetV1PostsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1PreferencesResponse ¶
type GetV1PreferencesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Preference `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1PreferencesResponse ¶
func ParseGetV1PreferencesResponse(rsp *http.Response) (*GetV1PreferencesResponse, error)
ParseGetV1PreferencesResponse parses an HTTP response from a GetV1PreferencesWithResponse call
func (GetV1PreferencesResponse) Status ¶
func (r GetV1PreferencesResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1PreferencesResponse) StatusCode ¶
func (r GetV1PreferencesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1ReadingSessionsParams ¶
type GetV1ReadingSessionsParams struct {
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1ReadingSessionsParams defines parameters for GetV1ReadingSessions.
type GetV1ReadingSessionsResponse ¶
type GetV1ReadingSessionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]ReadingSession `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1ReadingSessionsResponse ¶
func ParseGetV1ReadingSessionsResponse(rsp *http.Response) (*GetV1ReadingSessionsResponse, error)
ParseGetV1ReadingSessionsResponse parses an HTTP response from a GetV1ReadingSessionsWithResponse call
func (GetV1ReadingSessionsResponse) Status ¶
func (r GetV1ReadingSessionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1ReadingSessionsResponse) StatusCode ¶
func (r GetV1ReadingSessionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1Streaks200DataStatus ¶
type GetV1Streaks200DataStatus string
type GetV1StreaksCurrentStreakDaysParams ¶
type GetV1StreaksCurrentStreakDaysParams struct {
// Type The type of the streak
Type GetV1StreaksCurrentStreakDaysParamsType `form:"type" json:"type"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
GetV1StreaksCurrentStreakDaysParams defines parameters for GetV1StreaksCurrentStreakDays.
type GetV1StreaksCurrentStreakDaysParamsType ¶
type GetV1StreaksCurrentStreakDaysParamsType string
GetV1StreaksCurrentStreakDaysParamsType defines parameters for GetV1StreaksCurrentStreakDays.
const (
GetV1StreaksCurrentStreakDaysParamsTypeQURAN GetV1StreaksCurrentStreakDaysParamsType = "QURAN"
)
Defines values for GetV1StreaksCurrentStreakDaysParamsType.
type GetV1StreaksCurrentStreakDaysResponse ¶
type GetV1StreaksCurrentStreakDaysResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// Days The number of days the current streak is active for.
Days int `json:"days"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1StreaksCurrentStreakDaysResponse ¶
func ParseGetV1StreaksCurrentStreakDaysResponse(rsp *http.Response) (*GetV1StreaksCurrentStreakDaysResponse, error)
ParseGetV1StreaksCurrentStreakDaysResponse parses an HTTP response from a GetV1StreaksCurrentStreakDaysWithResponse call
func (GetV1StreaksCurrentStreakDaysResponse) Status ¶
func (r GetV1StreaksCurrentStreakDaysResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1StreaksCurrentStreakDaysResponse) StatusCode ¶
func (r GetV1StreaksCurrentStreakDaysResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1StreaksParams ¶
type GetV1StreaksParams struct {
// From The date after which any streaks would be returned (inclusive)
From *string `form:"from,omitempty" json:"from,omitempty"`
// To The date before which any streaks would be returned (inclusive)
To *string `form:"to,omitempty" json:"to,omitempty"`
// Type The type of the streak
Type *GetV1StreaksParamsType `form:"type,omitempty" json:"type,omitempty"`
// SortOrder The sorting order of `orderBy` field
SortOrder *GetV1StreaksParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
// OrderBy Which field to order the streaks by
OrderBy *GetV1StreaksParamsOrderBy `form:"orderBy,omitempty" json:"orderBy,omitempty"`
// Status The status of the streak.
Status *GetV1StreaksParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// Last The number of items to be fetched. Should be used together with `before`
Last *int `form:"last,omitempty" json:"last,omitempty"`
// First The number of items to be fetched.
First *int `form:"first,omitempty" json:"first,omitempty"`
// After The cursor after which you want to get the next page of items. Should be used together with `first`
After *string `form:"after,omitempty" json:"after,omitempty"`
// Before The cursor before which the previous page of items will be fetched. Should be used together with `last`
Before *string `form:"before,omitempty" json:"before,omitempty"`
}
GetV1StreaksParams defines parameters for GetV1Streaks.
type GetV1StreaksParamsOrderBy ¶
type GetV1StreaksParamsOrderBy string
GetV1StreaksParamsOrderBy defines parameters for GetV1Streaks.
const ( Days GetV1StreaksParamsOrderBy = "days" StartDate GetV1StreaksParamsOrderBy = "startDate" )
Defines values for GetV1StreaksParamsOrderBy.
type GetV1StreaksParamsSortOrder ¶
type GetV1StreaksParamsSortOrder string
GetV1StreaksParamsSortOrder defines parameters for GetV1Streaks.
const ( GetV1StreaksParamsSortOrderAsc GetV1StreaksParamsSortOrder = "asc" GetV1StreaksParamsSortOrderDesc GetV1StreaksParamsSortOrder = "desc" )
Defines values for GetV1StreaksParamsSortOrder.
type GetV1StreaksParamsStatus ¶
type GetV1StreaksParamsStatus string
GetV1StreaksParamsStatus defines parameters for GetV1Streaks.
const ( ACTIVE GetV1StreaksParamsStatus = "ACTIVE" BROKEN GetV1StreaksParamsStatus = "BROKEN" )
Defines values for GetV1StreaksParamsStatus.
type GetV1StreaksParamsType ¶
type GetV1StreaksParamsType string
GetV1StreaksParamsType defines parameters for GetV1Streaks.
const (
GetV1StreaksParamsTypeQURAN GetV1StreaksParamsType = "QURAN"
)
Defines values for GetV1StreaksParamsType.
type GetV1StreaksResponse ¶
type GetV1StreaksResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *[]struct {
// Days The number of days the streak is/was active for.
Days int `json:"days"`
// EndDate The date of the streak.
EndDate string `json:"endDate"`
// Id The id of the streak.
Id string `json:"id"`
// StartDate The date of the streak.
StartDate string `json:"startDate"`
// Status The status of the streak.
Status GetV1Streaks200DataStatus `json:"status"`
} `json:"data,omitempty"`
Pagination *struct {
EndCursor *string `json:"endCursor,omitempty"`
HasNextPage *bool `json:"hasNextPage,omitempty"`
HasPreviousPage *bool `json:"hasPreviousPage,omitempty"`
StartCursor *string `json:"startCursor,omitempty"`
} `json:"pagination,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1StreaksResponse ¶
func ParseGetV1StreaksResponse(rsp *http.Response) (*GetV1StreaksResponse, error)
ParseGetV1StreaksResponse parses an HTTP response from a GetV1StreaksWithResponse call
func (GetV1StreaksResponse) Status ¶
func (r GetV1StreaksResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1StreaksResponse) StatusCode ¶
func (r GetV1StreaksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1UsersNotificationsResponse ¶
type GetV1UsersNotificationsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Notifications *[]Notification `json:"notifications,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1UsersNotificationsResponse ¶
func ParseGetV1UsersNotificationsResponse(rsp *http.Response) (*GetV1UsersNotificationsResponse, error)
ParseGetV1UsersNotificationsResponse parses an HTTP response from a GetV1UsersNotificationsWithResponse call
func (GetV1UsersNotificationsResponse) Status ¶
func (r GetV1UsersNotificationsResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1UsersNotificationsResponse) StatusCode ¶
func (r GetV1UsersNotificationsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetV1UsersProfileResponse ¶
type GetV1UsersProfileResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *UserProfile `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParseGetV1UsersProfileResponse ¶
func ParseGetV1UsersProfileResponse(rsp *http.Response) (*GetV1UsersProfileResponse, error)
ParseGetV1UsersProfileResponse parses an HTTP response from a GetV1UsersProfileWithResponse call
func (GetV1UsersProfileResponse) Status ¶
func (r GetV1UsersProfileResponse) Status() string
Status returns HTTPResponse.Status
func (GetV1UsersProfileResponse) StatusCode ¶
func (r GetV1UsersProfileResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type Notification ¶
type Notification struct {
// AvatarUrl The Avatar url of the user the notification is related to.
AvatarUrl string `json:"avatarUrl"`
// Body The notification body. Might contain HTML.
Body string `json:"body"`
// CreatedAt The creation date of the notification.
CreatedAt string `json:"createdAt"`
// Id The notification Id.
Id int `json:"id"`
// PostUrl The post URL the notification is related to.
PostUrl string `json:"postUrl"`
}
Notification defines model for Notification.
type NotificationSettings ¶
type NotificationSettings struct {
// AddedPostInGroupNotification User receives an email when someone in a group the user is in creates a new post.
AddedPostInGroupNotification *bool `json:"addedPostInGroupNotification,omitempty"`
// AddedPostInGroupPushNotification User receives a notification when someone in a group the user is in creates a new post.
AddedPostInGroupPushNotification *bool `json:"addedPostInGroupPushNotification,omitempty"`
// EmailsDisabled Disable Email Notifications
EmailsDisabled *bool `json:"emailsDisabled,omitempty"`
// FollowNotification User receives an email when someone follows the user
FollowNotification *bool `json:"followNotification,omitempty"`
// FollowPushNotification User receives a notification when someone follows the user.
FollowPushNotification *bool `json:"followPushNotification,omitempty"`
// FollowedUserAddedPostNotification User receives an email when someone the user follows adds a new post.
FollowedUserAddedPostNotification *bool `json:"followedUserAddedPostNotification,omitempty"`
// FollowedUserAddedPostPushNotification User receives a notification when someone that the user follows adds a new post.
FollowedUserAddedPostPushNotification *bool `json:"followedUserAddedPostPushNotification,omitempty"`
// MentionNotification User receives an email when someone mentions the user in a post or comment.
MentionNotification *bool `json:"mentionNotification,omitempty"`
// MentionPushNotification User receives a notification when someone mentions the user in a post or comment.
MentionPushNotification *bool `json:"mentionPushNotification,omitempty"`
// PostCommentedNotification Receive email when someone comments on the user's post.
PostCommentedNotification *bool `json:"postCommentedNotification,omitempty"`
// PostCommentedPushNotification User receives a notification when someone comments on the user's post.
PostCommentedPushNotification *bool `json:"postCommentedPushNotification,omitempty"`
// PostLikedNotification Receive email when someone likes the user's post.
PostLikedNotification *bool `json:"postLikedNotification,omitempty"`
// PostLikedPushNotification User receives a notification when someone likes the user's post.
PostLikedPushNotification *bool `json:"postLikedPushNotification,omitempty"`
}
NotificationSettings defines model for NotificationSettings.
type PatchV1NotesNoteId200DataAttachedEntitiesEntityType ¶
type PatchV1NotesNoteId200DataAttachedEntitiesEntityType string
type PatchV1NotesNoteIdJSONBody ¶
type PatchV1NotesNoteIdJSONBody struct {
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// SaveToQR Indicates whether the updated note should be saved to the QuranReflect, defaults to false.
SaveToQR *bool `json:"saveToQR,omitempty"`
}
PatchV1NotesNoteIdJSONBody defines parameters for PatchV1NotesNoteId.
type PatchV1NotesNoteIdJSONRequestBody ¶
type PatchV1NotesNoteIdJSONRequestBody PatchV1NotesNoteIdJSONBody
PatchV1NotesNoteIdJSONRequestBody defines body for PatchV1NotesNoteId for application/json ContentType.
type PatchV1NotesNoteIdResponse ¶
type PatchV1NotesNoteIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType PatchV1NotesNoteId200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePatchV1NotesNoteIdResponse ¶
func ParsePatchV1NotesNoteIdResponse(rsp *http.Response) (*PatchV1NotesNoteIdResponse, error)
ParsePatchV1NotesNoteIdResponse parses an HTTP response from a PatchV1NotesNoteIdWithResponse call
func (PatchV1NotesNoteIdResponse) Status ¶
func (r PatchV1NotesNoteIdResponse) Status() string
Status returns HTTPResponse.Status
func (PatchV1NotesNoteIdResponse) StatusCode ¶
func (r PatchV1NotesNoteIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Post ¶
type Post struct {
// Author Details about the author.
Author *Author `json:"author,omitempty"`
// Body The body of the post.
Body string `json:"body"`
// Comments List of comments that belong to the post.
Comments *[]Comment `json:"comments,omitempty"`
// CommentsCount The number of comments the post has. This includes private comments.
CommentsCount int `json:"commentsCount"`
// CreatedAt The date the post was created at. Format of the date is `MMMM dd, yyyy HH:mm`
CreatedAt string `json:"createdAt"`
// Deletable Whether the post is deletable or not. It will be `true` if the post belongs to the current user.
Deletable bool `json:"deletable"`
// Editable Whether the post is editable or not. It will be `true` if the post belongs to the current user.
Editable bool `json:"editable"`
// EstimatedReadingTime The average number of milliseconds it takes to read the post. It can be `0` if the value could not be estimated.
EstimatedReadingTime float32 `json:"estimatedReadingTime"`
// Global Whether the post is global or not. A post inside a room can be set to global and becomes visible to everyone.
Global bool `json:"global"`
// Group The name of the group the post belongs to. Will be `null` it the post does not belong to a group.
Group *string `json:"group"`
// GroupLink The link to the group the post belongs to. Will be `null` it the post does not belong to a group.
GroupLink *string `json:"groupLink"`
// Hidden Whether the post is hidden or not.
Hidden bool `json:"hidden"`
// Id The ID of the post.
Id int `json:"id"`
// IsPrivate Whether the post should be publicly viewed or not.
IsPrivate bool `json:"isPrivate"`
// Language The language of the post.
Language string `json:"language"`
// LastUpdated The date the post was last updated. Format of the date is `MMMM dd, yyyy HH:mm`
LastUpdated string `json:"lastUpdated"`
// Liked Whether the post was liked by the current user or not.
Liked bool `json:"liked"`
// Likes The number of likes.
Likes int `json:"likes"`
// PostTitle A social-media sharable title of the post.
PostTitle string `json:"postTitle"`
// PublicCommentsCount The number of public comments the post has.
PublicCommentsCount int `json:"publicCommentsCount"`
// PublishedAt The date the post was published at. Format of the date is `MMMM dd, yyyy HH:mm`
PublishedAt string `json:"publishedAt"`
References *[]PostReference `json:"references,omitempty"`
// Reportable Whether the current user can report the post or not.
Reportable bool `json:"reportable"`
// Restorable Whether the current user can restore the post after it was deleted or not.
Restorable bool `json:"restorable"`
// RoomId The Id of the room the post belongs to.
RoomId *int `json:"roomId"`
// RoomPostStatus The room post status.
RoomPostStatus RoomPostStatus `json:"roomPostStatus"`
// Saved Whether the post was saved by the current user or not.
Saved bool `json:"saved"`
// Tags List of tags the post belongs to. If `tags` not passed with update post API, existing references of the post will be removed.
Tags *[]PostTag `json:"tags,omitempty"`
// Verified Whether the post is verified or not.
Verified bool `json:"verified"`
// Views The number of views.
Views int `json:"views"`
}
Post defines model for Post.
type PostReference ¶
type PostReference struct {
// FromAyah The start of the range of Ayah(s) in a Surah that the post relates to.
//
// If it's a single Ayah,`fromAyah` and `toAyah` should have the same value.
//
// If the post belongs to the entire Surah, `fromAyah` and `toAyah` should be left empty
FromAyah *int `json:"fromAyah"`
// IsSurah Whether the post belongs to the entire Surah.
IsSurah *bool `json:"isSurah,omitempty"`
// SurahId The Surah number
SurahId int `json:"surahId"`
// ToAyah The end of the range of Ayah(s) in a Surah that the post relates to.
//
// If it's a single Ayah,`fromAyah` and `toAyah` should have the same value.
//
// If the post belongs to the entire Surah, `fromAyah` and `toAyah` should be left empty
ToAyah *int `json:"toAyah"`
}
PostReference defines model for PostReference.
type PostTag ¶
type PostTag struct {
// Id The Id of the tag
Id int `json:"id"`
// Language The language of the tag.
Language string `json:"language"`
// Name The name of the tag.
Name string `json:"name"`
}
PostTag defines model for PostTag.
type PostV1ActivityDaysJSONBody ¶
type PostV1ActivityDaysJSONBody struct {
// Date The date of the activity day, can be today or a past date. If not passed, default to today
Date *string `json:"date,omitempty"`
// Type The type of the activity day
Type PostV1ActivityDaysJSONBodyType `json:"type"`
// contains filtered or unexported fields
}
PostV1ActivityDaysJSONBody defines parameters for PostV1ActivityDays.
type PostV1ActivityDaysJSONBody0 ¶
type PostV1ActivityDaysJSONBody0 struct {
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId PostV1ActivityDaysJSONBody0MushafId `json:"mushafId"`
// Ranges Current request's read range of Ayahs
Ranges []string `json:"ranges"`
// Seconds Seconds spent reading the current request's ranges
Seconds int `json:"seconds"`
}
PostV1ActivityDaysJSONBody0 defines parameters for PostV1ActivityDays.
type PostV1ActivityDaysJSONBody0MushafId ¶
type PostV1ActivityDaysJSONBody0MushafId int
PostV1ActivityDaysJSONBody0MushafId defines parameters for PostV1ActivityDays.
const ( PostV1ActivityDaysJSONBody0MushafIdN1 PostV1ActivityDaysJSONBody0MushafId = 1 PostV1ActivityDaysJSONBody0MushafIdN11 PostV1ActivityDaysJSONBody0MushafId = 11 PostV1ActivityDaysJSONBody0MushafIdN19 PostV1ActivityDaysJSONBody0MushafId = 19 PostV1ActivityDaysJSONBody0MushafIdN2 PostV1ActivityDaysJSONBody0MushafId = 2 PostV1ActivityDaysJSONBody0MushafIdN3 PostV1ActivityDaysJSONBody0MushafId = 3 PostV1ActivityDaysJSONBody0MushafIdN4 PostV1ActivityDaysJSONBody0MushafId = 4 PostV1ActivityDaysJSONBody0MushafIdN5 PostV1ActivityDaysJSONBody0MushafId = 5 PostV1ActivityDaysJSONBody0MushafIdN6 PostV1ActivityDaysJSONBody0MushafId = 6 PostV1ActivityDaysJSONBody0MushafIdN7 PostV1ActivityDaysJSONBody0MushafId = 7 )
Defines values for PostV1ActivityDaysJSONBody0MushafId.
type PostV1ActivityDaysJSONBodyType ¶
type PostV1ActivityDaysJSONBodyType string
PostV1ActivityDaysJSONBodyType defines parameters for PostV1ActivityDays.
const ( PostV1ActivityDaysJSONBodyTypeLESSON PostV1ActivityDaysJSONBodyType = "LESSON" PostV1ActivityDaysJSONBodyTypeQURAN PostV1ActivityDaysJSONBodyType = "QURAN" PostV1ActivityDaysJSONBodyTypeQURANREADINGPROGRAM PostV1ActivityDaysJSONBodyType = "QURAN_READING_PROGRAM" )
Defines values for PostV1ActivityDaysJSONBodyType.
type PostV1ActivityDaysJSONRequestBody ¶
type PostV1ActivityDaysJSONRequestBody PostV1ActivityDaysJSONBody
PostV1ActivityDaysJSONRequestBody defines body for PostV1ActivityDays for application/json ContentType.
type PostV1ActivityDaysParams ¶
type PostV1ActivityDaysParams struct {
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
PostV1ActivityDaysParams defines parameters for PostV1ActivityDays.
type PostV1ActivityDaysResponse ¶
type PostV1ActivityDaysResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *map[string]interface{} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1ActivityDaysResponse ¶
func ParsePostV1ActivityDaysResponse(rsp *http.Response) (*PostV1ActivityDaysResponse, error)
ParsePostV1ActivityDaysResponse parses an HTTP response from a PostV1ActivityDaysWithResponse call
func (PostV1ActivityDaysResponse) Status ¶
func (r PostV1ActivityDaysResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1ActivityDaysResponse) StatusCode ¶
func (r PostV1ActivityDaysResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1BookmarksJSONBody ¶
type PostV1BookmarksJSONBody struct {
// contains filtered or unexported fields
}
PostV1BookmarksJSONBody defines parameters for PostV1Bookmarks.
type PostV1BookmarksJSONBody0 ¶
type PostV1BookmarksJSONBody0 struct {
// Key The Surah number.
Key int `json:"key"`
// Mushaf The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
Mushaf PostV1BookmarksJSONBody0Mushaf `json:"mushaf"`
// Type The bookmark type.
Type *PostV1BookmarksJSONBody0Type `json:"type,omitempty"`
// VerseNumber The Ayah number to be added.
VerseNumber int `json:"verseNumber"`
}
PostV1BookmarksJSONBody0 defines parameters for PostV1Bookmarks.
type PostV1BookmarksJSONBody0Mushaf ¶
type PostV1BookmarksJSONBody0Mushaf int
PostV1BookmarksJSONBody0Mushaf defines parameters for PostV1Bookmarks.
const ( PostV1BookmarksJSONBody0MushafN1 PostV1BookmarksJSONBody0Mushaf = 1 PostV1BookmarksJSONBody0MushafN11 PostV1BookmarksJSONBody0Mushaf = 11 PostV1BookmarksJSONBody0MushafN19 PostV1BookmarksJSONBody0Mushaf = 19 PostV1BookmarksJSONBody0MushafN2 PostV1BookmarksJSONBody0Mushaf = 2 PostV1BookmarksJSONBody0MushafN3 PostV1BookmarksJSONBody0Mushaf = 3 PostV1BookmarksJSONBody0MushafN4 PostV1BookmarksJSONBody0Mushaf = 4 PostV1BookmarksJSONBody0MushafN5 PostV1BookmarksJSONBody0Mushaf = 5 PostV1BookmarksJSONBody0MushafN6 PostV1BookmarksJSONBody0Mushaf = 6 PostV1BookmarksJSONBody0MushafN7 PostV1BookmarksJSONBody0Mushaf = 7 )
Defines values for PostV1BookmarksJSONBody0Mushaf.
type PostV1BookmarksJSONBody0Type ¶
type PostV1BookmarksJSONBody0Type string
PostV1BookmarksJSONBody0Type defines parameters for PostV1Bookmarks.
const (
PostV1BookmarksJSONBody0TypeAyah PostV1BookmarksJSONBody0Type = "ayah"
)
Defines values for PostV1BookmarksJSONBody0Type.
type PostV1BookmarksJSONBody1 ¶
type PostV1BookmarksJSONBody1 struct {
// Key Surah, Juz or page number.
Key int `json:"key"`
// Mushaf The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
Mushaf PostV1BookmarksJSONBody1Mushaf `json:"mushaf"`
// Type The bookmark type.
Type *PostV1BookmarksJSONBody1Type `json:"type,omitempty"`
}
PostV1BookmarksJSONBody1 defines parameters for PostV1Bookmarks.
type PostV1BookmarksJSONBody1Mushaf ¶
type PostV1BookmarksJSONBody1Mushaf int
PostV1BookmarksJSONBody1Mushaf defines parameters for PostV1Bookmarks.
const ( PostV1BookmarksJSONBody1MushafN1 PostV1BookmarksJSONBody1Mushaf = 1 PostV1BookmarksJSONBody1MushafN11 PostV1BookmarksJSONBody1Mushaf = 11 PostV1BookmarksJSONBody1MushafN19 PostV1BookmarksJSONBody1Mushaf = 19 PostV1BookmarksJSONBody1MushafN2 PostV1BookmarksJSONBody1Mushaf = 2 PostV1BookmarksJSONBody1MushafN3 PostV1BookmarksJSONBody1Mushaf = 3 PostV1BookmarksJSONBody1MushafN4 PostV1BookmarksJSONBody1Mushaf = 4 PostV1BookmarksJSONBody1MushafN5 PostV1BookmarksJSONBody1Mushaf = 5 PostV1BookmarksJSONBody1MushafN6 PostV1BookmarksJSONBody1Mushaf = 6 PostV1BookmarksJSONBody1MushafN7 PostV1BookmarksJSONBody1Mushaf = 7 )
Defines values for PostV1BookmarksJSONBody1Mushaf.
type PostV1BookmarksJSONBody1Type ¶
type PostV1BookmarksJSONBody1Type string
PostV1BookmarksJSONBody1Type defines parameters for PostV1Bookmarks.
const ( PostV1BookmarksJSONBody1TypeJuz PostV1BookmarksJSONBody1Type = "juz" PostV1BookmarksJSONBody1TypePage PostV1BookmarksJSONBody1Type = "page" PostV1BookmarksJSONBody1TypeSurah PostV1BookmarksJSONBody1Type = "surah" )
Defines values for PostV1BookmarksJSONBody1Type.
type PostV1BookmarksJSONRequestBody ¶
type PostV1BookmarksJSONRequestBody PostV1BookmarksJSONBody
PostV1BookmarksJSONRequestBody defines body for PostV1Bookmarks for application/json ContentType.
type PostV1BookmarksResponse ¶
type PostV1BookmarksResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Bookmark `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1BookmarksResponse ¶
func ParsePostV1BookmarksResponse(rsp *http.Response) (*PostV1BookmarksResponse, error)
ParsePostV1BookmarksResponse parses an HTTP response from a PostV1BookmarksWithResponse call
func (PostV1BookmarksResponse) Status ¶
func (r PostV1BookmarksResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1BookmarksResponse) StatusCode ¶
func (r PostV1BookmarksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1CollectionsCollectionIdBookmarksJSONBody ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody struct {
// contains filtered or unexported fields
}
PostV1CollectionsCollectionIdBookmarksJSONBody defines parameters for PostV1CollectionsCollectionIdBookmarks.
type PostV1CollectionsCollectionIdBookmarksJSONBody0 ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody0 struct {
// Key The Surah number.
Key int `json:"key"`
// Mushaf The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
Mushaf PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf `json:"mushaf"`
// Type The bookmark type.
Type *PostV1CollectionsCollectionIdBookmarksJSONBody0Type `json:"type,omitempty"`
VerseNumber int `json:"verseNumber"`
}
PostV1CollectionsCollectionIdBookmarksJSONBody0 defines parameters for PostV1CollectionsCollectionIdBookmarks.
type PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf int
PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf defines parameters for PostV1CollectionsCollectionIdBookmarks.
const ( PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN1 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 1 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN11 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 11 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN19 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 19 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN2 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 2 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN3 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 3 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN4 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 4 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN5 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 5 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN6 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 6 PostV1CollectionsCollectionIdBookmarksJSONBody0MushafN7 PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf = 7 )
Defines values for PostV1CollectionsCollectionIdBookmarksJSONBody0Mushaf.
type PostV1CollectionsCollectionIdBookmarksJSONBody0Type ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody0Type string
PostV1CollectionsCollectionIdBookmarksJSONBody0Type defines parameters for PostV1CollectionsCollectionIdBookmarks.
const (
Ayah PostV1CollectionsCollectionIdBookmarksJSONBody0Type = "ayah"
)
Defines values for PostV1CollectionsCollectionIdBookmarksJSONBody0Type.
type PostV1CollectionsCollectionIdBookmarksJSONBody1 ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody1 struct {
// Key Surah, Juz or page number.
Key int `json:"key"`
// Mushaf The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
Mushaf PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf `json:"mushaf"`
// Type The bookmark type.
Type *PostV1CollectionsCollectionIdBookmarksJSONBody1Type `json:"type,omitempty"`
}
PostV1CollectionsCollectionIdBookmarksJSONBody1 defines parameters for PostV1CollectionsCollectionIdBookmarks.
type PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf int
PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf defines parameters for PostV1CollectionsCollectionIdBookmarks.
const ( PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN1 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 1 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN11 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 11 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN19 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 19 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN2 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 2 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN3 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 3 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN4 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 4 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN5 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 5 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN6 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 6 PostV1CollectionsCollectionIdBookmarksJSONBody1MushafN7 PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf = 7 )
Defines values for PostV1CollectionsCollectionIdBookmarksJSONBody1Mushaf.
type PostV1CollectionsCollectionIdBookmarksJSONBody1Type ¶
type PostV1CollectionsCollectionIdBookmarksJSONBody1Type string
PostV1CollectionsCollectionIdBookmarksJSONBody1Type defines parameters for PostV1CollectionsCollectionIdBookmarks.
const ( Juz PostV1CollectionsCollectionIdBookmarksJSONBody1Type = "juz" Page PostV1CollectionsCollectionIdBookmarksJSONBody1Type = "page" Surah PostV1CollectionsCollectionIdBookmarksJSONBody1Type = "surah" )
Defines values for PostV1CollectionsCollectionIdBookmarksJSONBody1Type.
type PostV1CollectionsCollectionIdBookmarksJSONRequestBody ¶
type PostV1CollectionsCollectionIdBookmarksJSONRequestBody PostV1CollectionsCollectionIdBookmarksJSONBody
PostV1CollectionsCollectionIdBookmarksJSONRequestBody defines body for PostV1CollectionsCollectionIdBookmarks for application/json ContentType.
type PostV1CollectionsCollectionIdBookmarksResponse ¶
type PostV1CollectionsCollectionIdBookmarksResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1CollectionsCollectionIdBookmarksResponse ¶
func ParsePostV1CollectionsCollectionIdBookmarksResponse(rsp *http.Response) (*PostV1CollectionsCollectionIdBookmarksResponse, error)
ParsePostV1CollectionsCollectionIdBookmarksResponse parses an HTTP response from a PostV1CollectionsCollectionIdBookmarksWithResponse call
func (PostV1CollectionsCollectionIdBookmarksResponse) Status ¶
func (r PostV1CollectionsCollectionIdBookmarksResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1CollectionsCollectionIdBookmarksResponse) StatusCode ¶
func (r PostV1CollectionsCollectionIdBookmarksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1CollectionsCollectionIdJSONBody ¶
type PostV1CollectionsCollectionIdJSONBody struct {
// Name The new name of the collection to be updated.
Name string `json:"name"`
}
PostV1CollectionsCollectionIdJSONBody defines parameters for PostV1CollectionsCollectionId.
type PostV1CollectionsCollectionIdJSONRequestBody ¶
type PostV1CollectionsCollectionIdJSONRequestBody PostV1CollectionsCollectionIdJSONBody
PostV1CollectionsCollectionIdJSONRequestBody defines body for PostV1CollectionsCollectionId for application/json ContentType.
type PostV1CollectionsCollectionIdResponse ¶
type PostV1CollectionsCollectionIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1CollectionsCollectionIdResponse ¶
func ParsePostV1CollectionsCollectionIdResponse(rsp *http.Response) (*PostV1CollectionsCollectionIdResponse, error)
ParsePostV1CollectionsCollectionIdResponse parses an HTTP response from a PostV1CollectionsCollectionIdWithResponse call
func (PostV1CollectionsCollectionIdResponse) Status ¶
func (r PostV1CollectionsCollectionIdResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1CollectionsCollectionIdResponse) StatusCode ¶
func (r PostV1CollectionsCollectionIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1CollectionsJSONBody ¶
type PostV1CollectionsJSONBody struct {
// Name The name of the new collection to be created.
Name string `json:"name"`
}
PostV1CollectionsJSONBody defines parameters for PostV1Collections.
type PostV1CollectionsJSONRequestBody ¶
type PostV1CollectionsJSONRequestBody PostV1CollectionsJSONBody
PostV1CollectionsJSONRequestBody defines body for PostV1Collections for application/json ContentType.
type PostV1CollectionsResponse ¶
type PostV1CollectionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *Collection `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1CollectionsResponse ¶
func ParsePostV1CollectionsResponse(rsp *http.Response) (*PostV1CollectionsResponse, error)
ParsePostV1CollectionsResponse parses an HTTP response from a PostV1CollectionsWithResponse call
func (PostV1CollectionsResponse) Status ¶
func (r PostV1CollectionsResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1CollectionsResponse) StatusCode ¶
func (r PostV1CollectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1CommentsJSONBody ¶
type PostV1CommentsJSONBody struct {
// contains filtered or unexported fields
}
PostV1CommentsJSONBody defines parameters for PostV1Comments.
type PostV1CommentsJSONBody0 ¶
type PostV1CommentsJSONBody0 struct {
// Body The body of the comment.
Body string `json:"body"`
// IsPrivate Whether the comment should be publicly viewed or not.
IsPrivate *bool `json:"isPrivate,omitempty"`
// PostId The ID of the post the comment will be added to.
PostId int `json:"postId"`
}
PostV1CommentsJSONBody0 defines parameters for PostV1Comments.
type PostV1CommentsJSONRequestBody ¶
type PostV1CommentsJSONRequestBody PostV1CommentsJSONBody
PostV1CommentsJSONRequestBody defines body for PostV1Comments for application/json ContentType.
type PostV1CommentsResponse ¶
type PostV1CommentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1CommentsResponse ¶
func ParsePostV1CommentsResponse(rsp *http.Response) (*PostV1CommentsResponse, error)
ParsePostV1CommentsResponse parses an HTTP response from a PostV1CommentsWithResponse call
func (PostV1CommentsResponse) Status ¶
func (r PostV1CommentsResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1CommentsResponse) StatusCode ¶
func (r PostV1CommentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1GoalsJSONBody ¶
type PostV1GoalsJSONBody struct {
// Amount The amount of the goal. Depending on the goal type, the amount value and format will be different
Amount PostV1GoalsJSONBody_Amount `json:"amount"`
// Category The category of the goal
Category PostV1GoalsJSONBodyCategory `json:"category"`
// Duration The duration of the goal in days. If it's empty it means the goal is a daily goal and not duration-based.
Duration *int `json:"duration,omitempty"`
// Type The type of the goal.
Type PostV1GoalsJSONBodyType `json:"type"`
}
PostV1GoalsJSONBody defines parameters for PostV1Goals.
type PostV1GoalsJSONBodyAmount0 ¶
type PostV1GoalsJSONBodyAmount0 = string
PostV1GoalsJSONBodyAmount0 defines parameters for PostV1Goals.
type PostV1GoalsJSONBodyAmount1 ¶
type PostV1GoalsJSONBodyAmount1 = int
PostV1GoalsJSONBodyAmount1 defines parameters for PostV1Goals.
type PostV1GoalsJSONBodyCategory ¶
type PostV1GoalsJSONBodyCategory string
PostV1GoalsJSONBodyCategory defines parameters for PostV1Goals.
const ( PostV1GoalsJSONBodyCategoryCOURSE PostV1GoalsJSONBodyCategory = "COURSE" PostV1GoalsJSONBodyCategoryQURAN PostV1GoalsJSONBodyCategory = "QURAN" PostV1GoalsJSONBodyCategoryQURANREADINGPROGRAM PostV1GoalsJSONBodyCategory = "QURAN_READING_PROGRAM" )
Defines values for PostV1GoalsJSONBodyCategory.
type PostV1GoalsJSONBodyType ¶
type PostV1GoalsJSONBodyType string
PostV1GoalsJSONBodyType defines parameters for PostV1Goals.
const ( PostV1GoalsJSONBodyTypeCOURSE PostV1GoalsJSONBodyType = "COURSE" PostV1GoalsJSONBodyTypeQURANPAGES PostV1GoalsJSONBodyType = "QURAN_PAGES" PostV1GoalsJSONBodyTypeQURANRANGE PostV1GoalsJSONBodyType = "QURAN_RANGE" PostV1GoalsJSONBodyTypeQURANREADINGPROGRAM PostV1GoalsJSONBodyType = "QURAN_READING_PROGRAM" PostV1GoalsJSONBodyTypeQURANTIME PostV1GoalsJSONBodyType = "QURAN_TIME" )
Defines values for PostV1GoalsJSONBodyType.
type PostV1GoalsJSONBody_Amount ¶
type PostV1GoalsJSONBody_Amount struct {
// contains filtered or unexported fields
}
PostV1GoalsJSONBody_Amount defines parameters for PostV1Goals.
type PostV1GoalsJSONRequestBody ¶
type PostV1GoalsJSONRequestBody PostV1GoalsJSONBody
PostV1GoalsJSONRequestBody defines body for PostV1Goals for application/json ContentType.
type PostV1GoalsParams ¶
type PostV1GoalsParams struct {
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId PostV1GoalsParamsMushafId `form:"mushafId" json:"mushafId"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
PostV1GoalsParams defines parameters for PostV1Goals.
type PostV1GoalsParamsMushafId ¶
type PostV1GoalsParamsMushafId int
PostV1GoalsParamsMushafId defines parameters for PostV1Goals.
const ( PostV1GoalsParamsMushafIdN1 PostV1GoalsParamsMushafId = 1 PostV1GoalsParamsMushafIdN11 PostV1GoalsParamsMushafId = 11 PostV1GoalsParamsMushafIdN19 PostV1GoalsParamsMushafId = 19 PostV1GoalsParamsMushafIdN2 PostV1GoalsParamsMushafId = 2 PostV1GoalsParamsMushafIdN3 PostV1GoalsParamsMushafId = 3 PostV1GoalsParamsMushafIdN4 PostV1GoalsParamsMushafId = 4 PostV1GoalsParamsMushafIdN5 PostV1GoalsParamsMushafId = 5 PostV1GoalsParamsMushafIdN6 PostV1GoalsParamsMushafId = 6 PostV1GoalsParamsMushafIdN7 PostV1GoalsParamsMushafId = 7 )
Defines values for PostV1GoalsParamsMushafId.
type PostV1GoalsResponse ¶
type PostV1GoalsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Id The id of the goal.
Id string `json:"id"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1GoalsResponse ¶
func ParsePostV1GoalsResponse(rsp *http.Response) (*PostV1GoalsResponse, error)
ParsePostV1GoalsResponse parses an HTTP response from a PostV1GoalsWithResponse call
func (PostV1GoalsResponse) Status ¶
func (r PostV1GoalsResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1GoalsResponse) StatusCode ¶
func (r PostV1GoalsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1Notes200DataAttachedEntitiesEntityType ¶
type PostV1Notes200DataAttachedEntitiesEntityType string
type PostV1NotesJSONBody ¶
type PostV1NotesJSONBody struct {
AttachedEntity *struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType PostV1NotesJSONBodyAttachedEntityEntityType `json:"entityType"`
} `json:"attachedEntity,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// SaveToQR Indicates whether the note should be saved to the QuranReflect.
SaveToQR bool `json:"saveToQR"`
}
PostV1NotesJSONBody defines parameters for PostV1Notes.
type PostV1NotesJSONBodyAttachedEntityEntityType ¶
type PostV1NotesJSONBodyAttachedEntityEntityType string
PostV1NotesJSONBodyAttachedEntityEntityType defines parameters for PostV1Notes.
const (
PostV1NotesJSONBodyAttachedEntityEntityTypeReflection PostV1NotesJSONBodyAttachedEntityEntityType = "reflection"
)
Defines values for PostV1NotesJSONBodyAttachedEntityEntityType.
type PostV1NotesJSONRequestBody ¶
type PostV1NotesJSONRequestBody PostV1NotesJSONBody
PostV1NotesJSONRequestBody defines body for PostV1Notes for application/json ContentType.
type PostV1NotesNoteIdPublishJSONBody ¶
type PostV1NotesNoteIdPublishJSONBody struct {
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
}
PostV1NotesNoteIdPublishJSONBody defines parameters for PostV1NotesNoteIdPublish.
type PostV1NotesNoteIdPublishJSONRequestBody ¶
type PostV1NotesNoteIdPublishJSONRequestBody PostV1NotesNoteIdPublishJSONBody
PostV1NotesNoteIdPublishJSONRequestBody defines body for PostV1NotesNoteIdPublish for application/json ContentType.
type PostV1NotesNoteIdPublishResponse ¶
type PostV1NotesNoteIdPublishResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
// Data Response object indicating the success of the note publishing operation and the optional post ID if successful.
Data *struct {
PostId *float32 `json:"postId,omitempty"`
Success bool `json:"success"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1NotesNoteIdPublishResponse ¶
func ParsePostV1NotesNoteIdPublishResponse(rsp *http.Response) (*PostV1NotesNoteIdPublishResponse, error)
ParsePostV1NotesNoteIdPublishResponse parses an HTTP response from a PostV1NotesNoteIdPublishWithResponse call
func (PostV1NotesNoteIdPublishResponse) Status ¶
func (r PostV1NotesNoteIdPublishResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1NotesNoteIdPublishResponse) StatusCode ¶
func (r PostV1NotesNoteIdPublishResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1NotesResponse ¶
type PostV1NotesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// AttachedEntities An array of attached entities associated with the note.
AttachedEntities *[]struct {
// EntityId The unique identifier for the attached entity.
EntityId string `json:"entityId"`
// EntityMetadata Additional metadata for the attached entity.
EntityMetadata *map[string]interface{} `json:"entityMetadata,omitempty"`
// EntityType The type of the attached entity, must be one of the predefined NoteEntityType values.
EntityType PostV1Notes200DataAttachedEntitiesEntityType `json:"entityType"`
} `json:"attachedEntities,omitempty"`
// Body The main content of the note, must be between the specified minimum and maximum length.
Body string `json:"body"`
// CreatedAt The creation date of the note.
CreatedAt time.Time `json:"createdAt"`
// Id The unique identifier of the note.
Id string `json:"id"`
// Ranges An array of verse ranges associated with the note.
Ranges *[]string `json:"ranges,omitempty"`
// Source The source of the note.
Source *string `json:"source,omitempty"`
// UpdatedAt The last update date of the note.
UpdatedAt time.Time `json:"updatedAt"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1NotesResponse ¶
func ParsePostV1NotesResponse(rsp *http.Response) (*PostV1NotesResponse, error)
ParsePostV1NotesResponse parses an HTTP response from a PostV1NotesWithResponse call
func (PostV1NotesResponse) Status ¶
func (r PostV1NotesResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1NotesResponse) StatusCode ¶
func (r PostV1NotesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PostsJSONBody ¶
type PostV1PostsJSONBody struct {
// contains filtered or unexported fields
}
PostV1PostsJSONBody defines parameters for PostV1Posts.
type PostV1PostsJSONBody0 ¶
type PostV1PostsJSONBody0 struct {
// Body The body of the post.
Body string `json:"body"`
// IsPrivate Whether the post should be posted as a private note.
IsPrivate *bool `json:"isPrivate,omitempty"`
// References The Surahs/Ayahs the post relates to.
References *[]PostReference `json:"references,omitempty"`
// RoomId The Id of the room the post will be posted in.
RoomId *int `json:"roomId,omitempty"`
// TagIds The Ids of the tags the post is attached to
TagIds *[]int `json:"tagIds,omitempty"`
}
PostV1PostsJSONBody0 defines parameters for PostV1Posts.
type PostV1PostsJSONRequestBody ¶
type PostV1PostsJSONRequestBody PostV1PostsJSONBody
PostV1PostsJSONRequestBody defines body for PostV1Posts for application/json ContentType.
type PostV1PostsReportPostIdJSONBody ¶
type PostV1PostsReportPostIdJSONBody struct {
// Abuse The report abuse type
Abuse PostV1PostsReportPostIdJSONBodyAbuse `json:"abuse"`
// Comment Report description/details.
Comment string `json:"comment"`
}
PostV1PostsReportPostIdJSONBody defines parameters for PostV1PostsReportPostId.
type PostV1PostsReportPostIdJSONBodyAbuse ¶
type PostV1PostsReportPostIdJSONBodyAbuse string
PostV1PostsReportPostIdJSONBodyAbuse defines parameters for PostV1PostsReportPostId.
const ( InappropriateContent PostV1PostsReportPostIdJSONBodyAbuse = "Inappropriate content" OffensiveLanguage PostV1PostsReportPostIdJSONBodyAbuse = "Offensive language" Other PostV1PostsReportPostIdJSONBodyAbuse = "Other" )
Defines values for PostV1PostsReportPostIdJSONBodyAbuse.
type PostV1PostsReportPostIdJSONRequestBody ¶
type PostV1PostsReportPostIdJSONRequestBody PostV1PostsReportPostIdJSONBody
PostV1PostsReportPostIdJSONRequestBody defines body for PostV1PostsReportPostId for application/json ContentType.
type PostV1PostsReportPostIdResponse ¶
type PostV1PostsReportPostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PostsReportPostIdResponse ¶
func ParsePostV1PostsReportPostIdResponse(rsp *http.Response) (*PostV1PostsReportPostIdResponse, error)
ParsePostV1PostsReportPostIdResponse parses an HTTP response from a PostV1PostsReportPostIdWithResponse call
func (PostV1PostsReportPostIdResponse) Status ¶
func (r PostV1PostsReportPostIdResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PostsReportPostIdResponse) StatusCode ¶
func (r PostV1PostsReportPostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PostsResponse ¶
type PostV1PostsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
PostId interface{} `json:"postId,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PostsResponse ¶
func ParsePostV1PostsResponse(rsp *http.Response) (*PostV1PostsResponse, error)
ParsePostV1PostsResponse parses an HTTP response from a PostV1PostsWithResponse call
func (PostV1PostsResponse) Status ¶
func (r PostV1PostsResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PostsResponse) StatusCode ¶
func (r PostV1PostsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PostsToggleLikePostIdJSONBody ¶
type PostV1PostsToggleLikePostIdJSONBody = map[string]interface{}
PostV1PostsToggleLikePostIdJSONBody defines parameters for PostV1PostsToggleLikePostId.
type PostV1PostsToggleLikePostIdJSONRequestBody ¶
type PostV1PostsToggleLikePostIdJSONRequestBody = PostV1PostsToggleLikePostIdJSONBody
PostV1PostsToggleLikePostIdJSONRequestBody defines body for PostV1PostsToggleLikePostId for application/json ContentType.
type PostV1PostsToggleLikePostIdResponse ¶
type PostV1PostsToggleLikePostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Liked *bool `json:"liked,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PostsToggleLikePostIdResponse ¶
func ParsePostV1PostsToggleLikePostIdResponse(rsp *http.Response) (*PostV1PostsToggleLikePostIdResponse, error)
ParsePostV1PostsToggleLikePostIdResponse parses an HTTP response from a PostV1PostsToggleLikePostIdWithResponse call
func (PostV1PostsToggleLikePostIdResponse) Status ¶
func (r PostV1PostsToggleLikePostIdResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PostsToggleLikePostIdResponse) StatusCode ¶
func (r PostV1PostsToggleLikePostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PostsToggleSavePostIdJSONBody ¶
type PostV1PostsToggleSavePostIdJSONBody = map[string]interface{}
PostV1PostsToggleSavePostIdJSONBody defines parameters for PostV1PostsToggleSavePostId.
type PostV1PostsToggleSavePostIdJSONRequestBody ¶
type PostV1PostsToggleSavePostIdJSONRequestBody = PostV1PostsToggleSavePostIdJSONBody
PostV1PostsToggleSavePostIdJSONRequestBody defines body for PostV1PostsToggleSavePostId for application/json ContentType.
type PostV1PostsToggleSavePostIdResponse ¶
type PostV1PostsToggleSavePostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Saved *bool `json:"saved,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PostsToggleSavePostIdResponse ¶
func ParsePostV1PostsToggleSavePostIdResponse(rsp *http.Response) (*PostV1PostsToggleSavePostIdResponse, error)
ParsePostV1PostsToggleSavePostIdResponse parses an HTTP response from a PostV1PostsToggleSavePostIdWithResponse call
func (PostV1PostsToggleSavePostIdResponse) Status ¶
func (r PostV1PostsToggleSavePostIdResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PostsToggleSavePostIdResponse) StatusCode ¶
func (r PostV1PostsToggleSavePostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PostsViewPostIdJSONBody ¶
type PostV1PostsViewPostIdJSONBody = map[string]interface{}
PostV1PostsViewPostIdJSONBody defines parameters for PostV1PostsViewPostId.
type PostV1PostsViewPostIdJSONRequestBody ¶
type PostV1PostsViewPostIdJSONRequestBody = PostV1PostsViewPostIdJSONBody
PostV1PostsViewPostIdJSONRequestBody defines body for PostV1PostsViewPostId for application/json ContentType.
type PostV1PostsViewPostIdResponse ¶
type PostV1PostsViewPostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Success *bool `json:"success,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PostsViewPostIdResponse ¶
func ParsePostV1PostsViewPostIdResponse(rsp *http.Response) (*PostV1PostsViewPostIdResponse, error)
ParsePostV1PostsViewPostIdResponse parses an HTTP response from a PostV1PostsViewPostIdWithResponse call
func (PostV1PostsViewPostIdResponse) Status ¶
func (r PostV1PostsViewPostIdResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PostsViewPostIdResponse) StatusCode ¶
func (r PostV1PostsViewPostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PreferencesBulkJSONRequestBody ¶
type PostV1PreferencesBulkJSONRequestBody = Preference
PostV1PreferencesBulkJSONRequestBody defines body for PostV1PreferencesBulk for application/json ContentType.
type PostV1PreferencesBulkParams ¶
type PostV1PreferencesBulkParams struct {
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId PostV1PreferencesBulkParamsMushafId `form:"mushafId" json:"mushafId"`
}
PostV1PreferencesBulkParams defines parameters for PostV1PreferencesBulk.
type PostV1PreferencesBulkParamsMushafId ¶
type PostV1PreferencesBulkParamsMushafId int
PostV1PreferencesBulkParamsMushafId defines parameters for PostV1PreferencesBulk.
const ( PostV1PreferencesBulkParamsMushafIdN1 PostV1PreferencesBulkParamsMushafId = 1 PostV1PreferencesBulkParamsMushafIdN11 PostV1PreferencesBulkParamsMushafId = 11 PostV1PreferencesBulkParamsMushafIdN19 PostV1PreferencesBulkParamsMushafId = 19 PostV1PreferencesBulkParamsMushafIdN2 PostV1PreferencesBulkParamsMushafId = 2 PostV1PreferencesBulkParamsMushafIdN3 PostV1PreferencesBulkParamsMushafId = 3 PostV1PreferencesBulkParamsMushafIdN4 PostV1PreferencesBulkParamsMushafId = 4 PostV1PreferencesBulkParamsMushafIdN5 PostV1PreferencesBulkParamsMushafId = 5 PostV1PreferencesBulkParamsMushafIdN6 PostV1PreferencesBulkParamsMushafId = 6 PostV1PreferencesBulkParamsMushafIdN7 PostV1PreferencesBulkParamsMushafId = 7 )
Defines values for PostV1PreferencesBulkParamsMushafId.
type PostV1PreferencesBulkResponse ¶
type PostV1PreferencesBulkResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PreferencesBulkResponse ¶
func ParsePostV1PreferencesBulkResponse(rsp *http.Response) (*PostV1PreferencesBulkResponse, error)
ParsePostV1PreferencesBulkResponse parses an HTTP response from a PostV1PreferencesBulkWithResponse call
func (PostV1PreferencesBulkResponse) Status ¶
func (r PostV1PreferencesBulkResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PreferencesBulkResponse) StatusCode ¶
func (r PostV1PreferencesBulkResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1PreferencesJSONBody ¶
type PostV1PreferencesJSONBody struct {
// Group The preference group to be added or updated.
Group PostV1PreferencesJSONBodyGroup `json:"group"`
// Key The preference key to be added or updated.
Key string `json:"key"`
// Value The preference value to be added or updated.
Value interface{} `json:"value"`
// contains filtered or unexported fields
}
PostV1PreferencesJSONBody defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody0 ¶
type PostV1PreferencesJSONBody0 struct {
Key *PostV1PreferencesJSONBody0Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody0 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody0Key ¶
type PostV1PreferencesJSONBody0Key string
PostV1PreferencesJSONBody0Key defines parameters for PostV1Preferences.
const (
Type PostV1PreferencesJSONBody0Key = "type"
)
Defines values for PostV1PreferencesJSONBody0Key.
type PostV1PreferencesJSONBody1 ¶
type PostV1PreferencesJSONBody1 struct {
Key *PostV1PreferencesJSONBody1Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody1 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody10 ¶
type PostV1PreferencesJSONBody10 struct {
Value PostV1PreferencesJSONBody10Value `json:"value"`
}
PostV1PreferencesJSONBody10 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody10Value ¶
type PostV1PreferencesJSONBody10Value string
PostV1PreferencesJSONBody10Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody10ValueBn PostV1PreferencesJSONBody10Value = "bn" PostV1PreferencesJSONBody10ValueDe PostV1PreferencesJSONBody10Value = "de" PostV1PreferencesJSONBody10ValueEn PostV1PreferencesJSONBody10Value = "en" PostV1PreferencesJSONBody10ValueFa PostV1PreferencesJSONBody10Value = "fa" PostV1PreferencesJSONBody10ValueFr PostV1PreferencesJSONBody10Value = "fr" PostV1PreferencesJSONBody10ValueHi PostV1PreferencesJSONBody10Value = "hi" PostV1PreferencesJSONBody10ValueId PostV1PreferencesJSONBody10Value = "id" PostV1PreferencesJSONBody10ValueInh PostV1PreferencesJSONBody10Value = "inh" PostV1PreferencesJSONBody10ValueRu PostV1PreferencesJSONBody10Value = "ru" PostV1PreferencesJSONBody10ValueTa PostV1PreferencesJSONBody10Value = "ta" PostV1PreferencesJSONBody10ValueTr PostV1PreferencesJSONBody10Value = "tr" PostV1PreferencesJSONBody10ValueUr PostV1PreferencesJSONBody10Value = "ur" )
Defines values for PostV1PreferencesJSONBody10Value.
type PostV1PreferencesJSONBody11 ¶
type PostV1PreferencesJSONBody11 struct {
Value PostV1PreferencesJSONBody11Value `json:"value"`
}
PostV1PreferencesJSONBody11 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody11Value ¶
type PostV1PreferencesJSONBody11Value string
PostV1PreferencesJSONBody11Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody11ValueNoAudio PostV1PreferencesJSONBody11Value = "no-audio" PostV1PreferencesJSONBody11ValuePlayAudio PostV1PreferencesJSONBody11Value = "play-audio" )
Defines values for PostV1PreferencesJSONBody11Value.
type PostV1PreferencesJSONBody12 ¶
type PostV1PreferencesJSONBody12 struct {
Value *bool `json:"value,omitempty"`
}
PostV1PreferencesJSONBody12 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody13 ¶
type PostV1PreferencesJSONBody13 struct {
Value []PostV1PreferencesJSONBody13Value `json:"value"`
}
PostV1PreferencesJSONBody13 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody13Value ¶
type PostV1PreferencesJSONBody13Value string
PostV1PreferencesJSONBody13Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody13ValueTranslation PostV1PreferencesJSONBody13Value = "translation" PostV1PreferencesJSONBody13ValueTransliteration PostV1PreferencesJSONBody13Value = "transliteration" )
Defines values for PostV1PreferencesJSONBody13Value.
type PostV1PreferencesJSONBody14 ¶
type PostV1PreferencesJSONBody14 struct {
Value []PostV1PreferencesJSONBody14Value `json:"value"`
}
PostV1PreferencesJSONBody14 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody14Value ¶
type PostV1PreferencesJSONBody14Value string
PostV1PreferencesJSONBody14Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody14ValueInline PostV1PreferencesJSONBody14Value = "inline" PostV1PreferencesJSONBody14ValueTooltip PostV1PreferencesJSONBody14Value = "tooltip" )
Defines values for PostV1PreferencesJSONBody14Value.
type PostV1PreferencesJSONBody15 ¶
type PostV1PreferencesJSONBody15 struct {
Value *PostV1PreferencesJSONBody15Value `json:"value,omitempty"`
}
PostV1PreferencesJSONBody15 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody15Value ¶
type PostV1PreferencesJSONBody15Value string
PostV1PreferencesJSONBody15Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody15ValueCodeV1 PostV1PreferencesJSONBody15Value = "code_v1" PostV1PreferencesJSONBody15ValueCodeV2 PostV1PreferencesJSONBody15Value = "code_v2" PostV1PreferencesJSONBody15ValueQpcUthmaniHafs PostV1PreferencesJSONBody15Value = "qpc_uthmani_hafs" PostV1PreferencesJSONBody15ValueTajweed PostV1PreferencesJSONBody15Value = "tajweed" PostV1PreferencesJSONBody15ValueTajweedV4 PostV1PreferencesJSONBody15Value = "tajweed_v4" PostV1PreferencesJSONBody15ValueTextIndopak PostV1PreferencesJSONBody15Value = "text_indopak" PostV1PreferencesJSONBody15ValueTextUthmani PostV1PreferencesJSONBody15Value = "text_uthmani" )
Defines values for PostV1PreferencesJSONBody15Value.
type PostV1PreferencesJSONBody16 ¶
type PostV1PreferencesJSONBody16 struct {
Value *PostV1PreferencesJSONBody16Value `json:"value,omitempty"`
}
PostV1PreferencesJSONBody16 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody16Value ¶
type PostV1PreferencesJSONBody16Value string
PostV1PreferencesJSONBody16Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody16ValueN15Lines PostV1PreferencesJSONBody16Value = "15_lines" PostV1PreferencesJSONBody16ValueN16Lines PostV1PreferencesJSONBody16Value = "16_lines" )
Defines values for PostV1PreferencesJSONBody16Value.
type PostV1PreferencesJSONBody17 ¶
type PostV1PreferencesJSONBody17 struct {
Value int `json:"value"`
}
PostV1PreferencesJSONBody17 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody18 ¶
type PostV1PreferencesJSONBody18 struct {
Value *int `json:"value,omitempty"`
}
PostV1PreferencesJSONBody18 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody19 ¶
type PostV1PreferencesJSONBody19 struct {
Value *[]int `json:"value,omitempty"`
}
PostV1PreferencesJSONBody19 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody1Key ¶
type PostV1PreferencesJSONBody1Key string
PostV1PreferencesJSONBody1Key defines parameters for PostV1Preferences.
const ( IsReadingByRevelationOrder PostV1PreferencesJSONBody1Key = "isReadingByRevelationOrder" ReadingPreference PostV1PreferencesJSONBody1Key = "readingPreference" SelectedWordByWordLocale PostV1PreferencesJSONBody1Key = "selectedWordByWordLocale" WordByWordContentType PostV1PreferencesJSONBody1Key = "wordByWordContentType" WordByWordDisplay PostV1PreferencesJSONBody1Key = "wordByWordDisplay" WordClickFunctionality PostV1PreferencesJSONBody1Key = "wordClickFunctionality" )
Defines values for PostV1PreferencesJSONBody1Key.
type PostV1PreferencesJSONBody2 ¶
type PostV1PreferencesJSONBody2 struct {
Key *PostV1PreferencesJSONBody2Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody2 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody20 ¶
type PostV1PreferencesJSONBody20 struct {
Value *[]string `json:"value,omitempty"`
}
PostV1PreferencesJSONBody20 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody21 ¶
type PostV1PreferencesJSONBody21 struct {
Value *PostV1PreferencesJSONBody21Value `json:"value,omitempty"`
}
PostV1PreferencesJSONBody21 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody21Value ¶
type PostV1PreferencesJSONBody21Value int
PostV1PreferencesJSONBody21Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody21ValueN025 PostV1PreferencesJSONBody21Value = 0.25 PostV1PreferencesJSONBody21ValueN05 PostV1PreferencesJSONBody21Value = 0.5 PostV1PreferencesJSONBody21ValueN075 PostV1PreferencesJSONBody21Value = 0.75 PostV1PreferencesJSONBody21ValueN1 PostV1PreferencesJSONBody21Value = 1 PostV1PreferencesJSONBody21ValueN125 PostV1PreferencesJSONBody21Value = 1.25 PostV1PreferencesJSONBody21ValueN15 PostV1PreferencesJSONBody21Value = 1.5 PostV1PreferencesJSONBody21ValueN175 PostV1PreferencesJSONBody21Value = 1.75 PostV1PreferencesJSONBody21ValueN2 PostV1PreferencesJSONBody21Value = 2 )
Defines values for PostV1PreferencesJSONBody21Value.
type PostV1PreferencesJSONBody2Key ¶
type PostV1PreferencesJSONBody2Key string
PostV1PreferencesJSONBody2Key defines parameters for PostV1Preferences.
const ( MushafLines PostV1PreferencesJSONBody2Key = "mushafLines" QuranFont PostV1PreferencesJSONBody2Key = "quranFont" QuranTextFontScale PostV1PreferencesJSONBody2Key = "quranTextFontScale" TafsirFontScale PostV1PreferencesJSONBody2Key = "tafsirFontScale" TranslationFontScale PostV1PreferencesJSONBody2Key = "translationFontScale" WordByWordFontScale PostV1PreferencesJSONBody2Key = "wordByWordFontScale" )
Defines values for PostV1PreferencesJSONBody2Key.
type PostV1PreferencesJSONBody3 ¶
type PostV1PreferencesJSONBody3 struct {
Key *PostV1PreferencesJSONBody3Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody3 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody3Key ¶
type PostV1PreferencesJSONBody3Key string
PostV1PreferencesJSONBody3Key defines parameters for PostV1Preferences.
const (
SelectedTranslations PostV1PreferencesJSONBody3Key = "selectedTranslations"
)
Defines values for PostV1PreferencesJSONBody3Key.
type PostV1PreferencesJSONBody4 ¶
type PostV1PreferencesJSONBody4 struct {
Key *PostV1PreferencesJSONBody4Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody4 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody4Key ¶
type PostV1PreferencesJSONBody4Key string
PostV1PreferencesJSONBody4Key defines parameters for PostV1Preferences.
const (
SelectedTafsirs PostV1PreferencesJSONBody4Key = "selectedTafsirs"
)
Defines values for PostV1PreferencesJSONBody4Key.
type PostV1PreferencesJSONBody5 ¶
type PostV1PreferencesJSONBody5 struct {
Key *PostV1PreferencesJSONBody5Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody5 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody5Key ¶
type PostV1PreferencesJSONBody5Key string
PostV1PreferencesJSONBody5Key defines parameters for PostV1Preferences.
const ( EnableAutoScrolling PostV1PreferencesJSONBody5Key = "enableAutoScrolling" PlaybackRate PostV1PreferencesJSONBody5Key = "playbackRate" Reciter PostV1PreferencesJSONBody5Key = "reciter" RepeatSettings PostV1PreferencesJSONBody5Key = "repeatSettings" ShowTooltipWhenPlayingAudio PostV1PreferencesJSONBody5Key = "showTooltipWhenPlayingAudio" )
Defines values for PostV1PreferencesJSONBody5Key.
type PostV1PreferencesJSONBody6 ¶
type PostV1PreferencesJSONBody6 struct {
Key *PostV1PreferencesJSONBody6Key `json:"key,omitempty"`
}
PostV1PreferencesJSONBody6 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody6Key ¶
type PostV1PreferencesJSONBody6Key string
PostV1PreferencesJSONBody6Key defines parameters for PostV1Preferences.
const (
PostV1PreferencesJSONBody6KeyLanguage PostV1PreferencesJSONBody6Key = "language"
)
Defines values for PostV1PreferencesJSONBody6Key.
type PostV1PreferencesJSONBody7 ¶
type PostV1PreferencesJSONBody7 struct {
Value *PostV1PreferencesJSONBody7Value `json:"value,omitempty"`
}
PostV1PreferencesJSONBody7 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody7Value ¶
type PostV1PreferencesJSONBody7Value string
PostV1PreferencesJSONBody7Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody7ValueAr PostV1PreferencesJSONBody7Value = "ar" PostV1PreferencesJSONBody7ValueBn PostV1PreferencesJSONBody7Value = "bn" PostV1PreferencesJSONBody7ValueEn PostV1PreferencesJSONBody7Value = "en" PostV1PreferencesJSONBody7ValueEs PostV1PreferencesJSONBody7Value = "es" PostV1PreferencesJSONBody7ValueFa PostV1PreferencesJSONBody7Value = "fa" PostV1PreferencesJSONBody7ValueFr PostV1PreferencesJSONBody7Value = "fr" PostV1PreferencesJSONBody7ValueId PostV1PreferencesJSONBody7Value = "id" PostV1PreferencesJSONBody7ValueIt PostV1PreferencesJSONBody7Value = "it" PostV1PreferencesJSONBody7ValueMs PostV1PreferencesJSONBody7Value = "ms" PostV1PreferencesJSONBody7ValueNl PostV1PreferencesJSONBody7Value = "nl" PostV1PreferencesJSONBody7ValuePt PostV1PreferencesJSONBody7Value = "pt" PostV1PreferencesJSONBody7ValueRu PostV1PreferencesJSONBody7Value = "ru" PostV1PreferencesJSONBody7ValueSq PostV1PreferencesJSONBody7Value = "sq" PostV1PreferencesJSONBody7ValueSw PostV1PreferencesJSONBody7Value = "sw" PostV1PreferencesJSONBody7ValueTh PostV1PreferencesJSONBody7Value = "th" PostV1PreferencesJSONBody7ValueTr PostV1PreferencesJSONBody7Value = "tr" PostV1PreferencesJSONBody7ValueUr PostV1PreferencesJSONBody7Value = "ur" PostV1PreferencesJSONBody7ValueZh PostV1PreferencesJSONBody7Value = "zh" )
Defines values for PostV1PreferencesJSONBody7Value.
type PostV1PreferencesJSONBody8 ¶
type PostV1PreferencesJSONBody8 struct {
Value *PostV1PreferencesJSONBody8Value `json:"value,omitempty"`
}
PostV1PreferencesJSONBody8 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody8Value ¶
type PostV1PreferencesJSONBody8Value string
PostV1PreferencesJSONBody8Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody8ValueAuto PostV1PreferencesJSONBody8Value = "auto" PostV1PreferencesJSONBody8ValueDark PostV1PreferencesJSONBody8Value = "dark" PostV1PreferencesJSONBody8ValueLight PostV1PreferencesJSONBody8Value = "light" PostV1PreferencesJSONBody8ValueSepia PostV1PreferencesJSONBody8Value = "sepia" )
Defines values for PostV1PreferencesJSONBody8Value.
type PostV1PreferencesJSONBody9 ¶
type PostV1PreferencesJSONBody9 struct {
Value PostV1PreferencesJSONBody9Value `json:"value"`
}
PostV1PreferencesJSONBody9 defines parameters for PostV1Preferences.
type PostV1PreferencesJSONBody9Value ¶
type PostV1PreferencesJSONBody9Value string
PostV1PreferencesJSONBody9Value defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBody9ValueReading PostV1PreferencesJSONBody9Value = "reading" PostV1PreferencesJSONBody9ValueTranslation PostV1PreferencesJSONBody9Value = "translation" )
Defines values for PostV1PreferencesJSONBody9Value.
type PostV1PreferencesJSONBodyGroup ¶
type PostV1PreferencesJSONBodyGroup string
PostV1PreferencesJSONBodyGroup defines parameters for PostV1Preferences.
const ( PostV1PreferencesJSONBodyGroupAudio PostV1PreferencesJSONBodyGroup = "audio" PostV1PreferencesJSONBodyGroupLanguage PostV1PreferencesJSONBodyGroup = "language" PostV1PreferencesJSONBodyGroupQuranReaderStyles PostV1PreferencesJSONBodyGroup = "quranReaderStyles" PostV1PreferencesJSONBodyGroupReading PostV1PreferencesJSONBodyGroup = "reading" PostV1PreferencesJSONBodyGroupTafsirs PostV1PreferencesJSONBodyGroup = "tafsirs" PostV1PreferencesJSONBodyGroupTheme PostV1PreferencesJSONBodyGroup = "theme" PostV1PreferencesJSONBodyGroupTranslations PostV1PreferencesJSONBodyGroup = "translations" )
Defines values for PostV1PreferencesJSONBodyGroup.
type PostV1PreferencesJSONRequestBody ¶
type PostV1PreferencesJSONRequestBody PostV1PreferencesJSONBody
PostV1PreferencesJSONRequestBody defines body for PostV1Preferences for application/json ContentType.
type PostV1PreferencesParams ¶
type PostV1PreferencesParams struct {
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId PostV1PreferencesParamsMushafId `form:"mushafId" json:"mushafId"`
}
PostV1PreferencesParams defines parameters for PostV1Preferences.
type PostV1PreferencesParamsMushafId ¶
type PostV1PreferencesParamsMushafId int
PostV1PreferencesParamsMushafId defines parameters for PostV1Preferences.
const ( PostV1PreferencesParamsMushafIdN1 PostV1PreferencesParamsMushafId = 1 PostV1PreferencesParamsMushafIdN11 PostV1PreferencesParamsMushafId = 11 PostV1PreferencesParamsMushafIdN19 PostV1PreferencesParamsMushafId = 19 PostV1PreferencesParamsMushafIdN2 PostV1PreferencesParamsMushafId = 2 PostV1PreferencesParamsMushafIdN3 PostV1PreferencesParamsMushafId = 3 PostV1PreferencesParamsMushafIdN4 PostV1PreferencesParamsMushafId = 4 PostV1PreferencesParamsMushafIdN5 PostV1PreferencesParamsMushafId = 5 PostV1PreferencesParamsMushafIdN6 PostV1PreferencesParamsMushafId = 6 PostV1PreferencesParamsMushafIdN7 PostV1PreferencesParamsMushafId = 7 )
Defines values for PostV1PreferencesParamsMushafId.
type PostV1PreferencesResponse ¶
type PostV1PreferencesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1PreferencesResponse ¶
func ParsePostV1PreferencesResponse(rsp *http.Response) (*PostV1PreferencesResponse, error)
ParsePostV1PreferencesResponse parses an HTTP response from a PostV1PreferencesWithResponse call
func (PostV1PreferencesResponse) Status ¶
func (r PostV1PreferencesResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1PreferencesResponse) StatusCode ¶
func (r PostV1PreferencesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1ReadingSessionsJSONBody ¶
type PostV1ReadingSessionsJSONBody struct {
// ChapterNumber The Surah number to be added to reading session.
ChapterNumber int `json:"chapterNumber"`
// VerseNumber The Ayah number to be added to reading session.
VerseNumber int `json:"verseNumber"`
}
PostV1ReadingSessionsJSONBody defines parameters for PostV1ReadingSessions.
type PostV1ReadingSessionsJSONRequestBody ¶
type PostV1ReadingSessionsJSONRequestBody PostV1ReadingSessionsJSONBody
PostV1ReadingSessionsJSONRequestBody defines body for PostV1ReadingSessions for application/json ContentType.
type PostV1ReadingSessionsResponse ¶
type PostV1ReadingSessionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1ReadingSessionsResponse ¶
func ParsePostV1ReadingSessionsResponse(rsp *http.Response) (*PostV1ReadingSessionsResponse, error)
ParsePostV1ReadingSessionsResponse parses an HTTP response from a PostV1ReadingSessionsWithResponse call
func (PostV1ReadingSessionsResponse) Status ¶
func (r PostV1ReadingSessionsResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1ReadingSessionsResponse) StatusCode ¶
func (r PostV1ReadingSessionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1UsersConfirmationEmailJSONBody ¶
type PostV1UsersConfirmationEmailJSONBody struct {
// Email The email to send the confirmation email to.
Email openapi_types.Email `json:"email"`
}
PostV1UsersConfirmationEmailJSONBody defines parameters for PostV1UsersConfirmationEmail.
type PostV1UsersConfirmationEmailJSONRequestBody ¶
type PostV1UsersConfirmationEmailJSONRequestBody PostV1UsersConfirmationEmailJSONBody
PostV1UsersConfirmationEmailJSONRequestBody defines body for PostV1UsersConfirmationEmail for application/json ContentType.
type PostV1UsersConfirmationEmailResponse ¶
type PostV1UsersConfirmationEmailResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *map[string]interface{} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1UsersConfirmationEmailResponse ¶
func ParsePostV1UsersConfirmationEmailResponse(rsp *http.Response) (*PostV1UsersConfirmationEmailResponse, error)
ParsePostV1UsersConfirmationEmailResponse parses an HTTP response from a PostV1UsersConfirmationEmailWithResponse call
func (PostV1UsersConfirmationEmailResponse) Status ¶
func (r PostV1UsersConfirmationEmailResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1UsersConfirmationEmailResponse) StatusCode ¶
func (r PostV1UsersConfirmationEmailResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1UsersPasswordResetEmailJSONBody ¶
type PostV1UsersPasswordResetEmailJSONBody struct {
// Email The email to send the reset password email to.
Email openapi_types.Email `json:"email"`
}
PostV1UsersPasswordResetEmailJSONBody defines parameters for PostV1UsersPasswordResetEmail.
type PostV1UsersPasswordResetEmailJSONRequestBody ¶
type PostV1UsersPasswordResetEmailJSONRequestBody PostV1UsersPasswordResetEmailJSONBody
PostV1UsersPasswordResetEmailJSONRequestBody defines body for PostV1UsersPasswordResetEmail for application/json ContentType.
type PostV1UsersPasswordResetEmailResponse ¶
type PostV1UsersPasswordResetEmailResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *map[string]interface{} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1UsersPasswordResetEmailResponse ¶
func ParsePostV1UsersPasswordResetEmailResponse(rsp *http.Response) (*PostV1UsersPasswordResetEmailResponse, error)
ParsePostV1UsersPasswordResetEmailResponse parses an HTTP response from a PostV1UsersPasswordResetEmailWithResponse call
func (PostV1UsersPasswordResetEmailResponse) Status ¶
func (r PostV1UsersPasswordResetEmailResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1UsersPasswordResetEmailResponse) StatusCode ¶
func (r PostV1UsersPasswordResetEmailResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1UsersUsernameRegisterAndroidDeviceJSONBody ¶
type PostV1UsersUsernameRegisterAndroidDeviceJSONBody struct {
// RegistrationId The Android device registration id of the user.
RegistrationId string `json:"registrationId"`
}
PostV1UsersUsernameRegisterAndroidDeviceJSONBody defines parameters for PostV1UsersUsernameRegisterAndroidDevice.
type PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody ¶
type PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody PostV1UsersUsernameRegisterAndroidDeviceJSONBody
PostV1UsersUsernameRegisterAndroidDeviceJSONRequestBody defines body for PostV1UsersUsernameRegisterAndroidDevice for application/json ContentType.
type PostV1UsersUsernameRegisterAndroidDeviceResponse ¶
type PostV1UsersUsernameRegisterAndroidDeviceResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1UsersUsernameRegisterAndroidDeviceResponse ¶
func ParsePostV1UsersUsernameRegisterAndroidDeviceResponse(rsp *http.Response) (*PostV1UsersUsernameRegisterAndroidDeviceResponse, error)
ParsePostV1UsersUsernameRegisterAndroidDeviceResponse parses an HTTP response from a PostV1UsersUsernameRegisterAndroidDeviceWithResponse call
func (PostV1UsersUsernameRegisterAndroidDeviceResponse) Status ¶
func (r PostV1UsersUsernameRegisterAndroidDeviceResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1UsersUsernameRegisterAndroidDeviceResponse) StatusCode ¶
func (r PostV1UsersUsernameRegisterAndroidDeviceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostV1UsersUsernameToggleFollowJSONBody ¶
type PostV1UsersUsernameToggleFollowJSONBody = map[string]interface{}
PostV1UsersUsernameToggleFollowJSONBody defines parameters for PostV1UsersUsernameToggleFollow.
type PostV1UsersUsernameToggleFollowJSONRequestBody ¶
type PostV1UsersUsernameToggleFollowJSONRequestBody = PostV1UsersUsernameToggleFollowJSONBody
PostV1UsersUsernameToggleFollowJSONRequestBody defines body for PostV1UsersUsernameToggleFollow for application/json ContentType.
type PostV1UsersUsernameToggleFollowResponse ¶
type PostV1UsersUsernameToggleFollowResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
// Followed Whether the user is now followed or not.
Followed *bool `json:"followed,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePostV1UsersUsernameToggleFollowResponse ¶
func ParsePostV1UsersUsernameToggleFollowResponse(rsp *http.Response) (*PostV1UsersUsernameToggleFollowResponse, error)
ParsePostV1UsersUsernameToggleFollowResponse parses an HTTP response from a PostV1UsersUsernameToggleFollowWithResponse call
func (PostV1UsersUsernameToggleFollowResponse) Status ¶
func (r PostV1UsersUsernameToggleFollowResponse) Status() string
Status returns HTTPResponse.Status
func (PostV1UsersUsernameToggleFollowResponse) StatusCode ¶
func (r PostV1UsersUsernameToggleFollowResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Preference ¶
type Preference struct {
Audio *struct {
EnableAutoScrolling *bool `json:"enableAutoScrolling,omitempty"`
PlaybackRate *PreferenceAudioPlaybackRate `json:"playbackRate,omitempty"`
Reciter int `json:"reciter"`
ShowTooltipWhenPlayingAudio *bool `json:"showTooltipWhenPlayingAudio,omitempty"`
} `json:"audio,omitempty"`
Language *struct {
Language *PreferenceLanguageLanguage `json:"language,omitempty"`
} `json:"language,omitempty"`
QuranReaderStyles *struct {
MushafLines *PreferenceQuranReaderStylesMushafLines `json:"mushafLines,omitempty"`
QuranFont *PreferenceQuranReaderStylesQuranFont `json:"quranFont,omitempty"`
QuranTextFontScale int `json:"quranTextFontScale"`
TafsirFontScale int `json:"tafsirFontScale"`
TranslationFontScale int `json:"translationFontScale"`
WordByWordFontScale int `json:"wordByWordFontScale"`
} `json:"quranReaderStyles,omitempty"`
Reading *struct {
IsReadingByRevelationOrder *bool `json:"isReadingByRevelationOrder,omitempty"`
ReadingPreference PreferenceReadingReadingPreference `json:"readingPreference"`
SelectedWordByWordLocale PreferenceReadingSelectedWordByWordLocale `json:"selectedWordByWordLocale"`
WordByWordContentType []PreferenceReadingWordByWordContentType `json:"wordByWordContentType"`
WordByWordDisplay []PreferenceReadingWordByWordDisplay `json:"wordByWordDisplay"`
WordClickFunctionality PreferenceReadingWordClickFunctionality `json:"wordClickFunctionality"`
} `json:"reading,omitempty"`
Tafsirs *struct {
SelectedTafsirs *[]string `json:"selectedTafsirs,omitempty"`
} `json:"tafsirs,omitempty"`
Theme *struct {
Type *PreferenceThemeType `json:"type,omitempty"`
} `json:"theme,omitempty"`
Translations *struct {
SelectedTranslations *[]int `json:"selectedTranslations,omitempty"`
} `json:"translations,omitempty"`
}
Preference defines model for Preference.
type PreferenceAudioPlaybackRate ¶
type PreferenceAudioPlaybackRate int
PreferenceAudioPlaybackRate defines model for Preference.Audio.PlaybackRate.
const ( PreferenceAudioPlaybackRateN025 PreferenceAudioPlaybackRate = 0.25 PreferenceAudioPlaybackRateN05 PreferenceAudioPlaybackRate = 0.5 PreferenceAudioPlaybackRateN075 PreferenceAudioPlaybackRate = 0.75 PreferenceAudioPlaybackRateN1 PreferenceAudioPlaybackRate = 1 PreferenceAudioPlaybackRateN125 PreferenceAudioPlaybackRate = 1.25 PreferenceAudioPlaybackRateN15 PreferenceAudioPlaybackRate = 1.5 PreferenceAudioPlaybackRateN175 PreferenceAudioPlaybackRate = 1.75 PreferenceAudioPlaybackRateN2 PreferenceAudioPlaybackRate = 2 )
Defines values for PreferenceAudioPlaybackRate.
type PreferenceLanguageLanguage ¶
type PreferenceLanguageLanguage string
PreferenceLanguageLanguage defines model for Preference.Language.Language.
const ( PreferenceLanguageLanguageAr PreferenceLanguageLanguage = "ar" PreferenceLanguageLanguageBn PreferenceLanguageLanguage = "bn" PreferenceLanguageLanguageEn PreferenceLanguageLanguage = "en" PreferenceLanguageLanguageEs PreferenceLanguageLanguage = "es" PreferenceLanguageLanguageFa PreferenceLanguageLanguage = "fa" PreferenceLanguageLanguageFr PreferenceLanguageLanguage = "fr" PreferenceLanguageLanguageId PreferenceLanguageLanguage = "id" PreferenceLanguageLanguageIt PreferenceLanguageLanguage = "it" PreferenceLanguageLanguageMs PreferenceLanguageLanguage = "ms" PreferenceLanguageLanguageNl PreferenceLanguageLanguage = "nl" PreferenceLanguageLanguagePt PreferenceLanguageLanguage = "pt" PreferenceLanguageLanguageRu PreferenceLanguageLanguage = "ru" PreferenceLanguageLanguageSq PreferenceLanguageLanguage = "sq" PreferenceLanguageLanguageSw PreferenceLanguageLanguage = "sw" PreferenceLanguageLanguageTh PreferenceLanguageLanguage = "th" PreferenceLanguageLanguageTr PreferenceLanguageLanguage = "tr" PreferenceLanguageLanguageUr PreferenceLanguageLanguage = "ur" PreferenceLanguageLanguageZh PreferenceLanguageLanguage = "zh" )
Defines values for PreferenceLanguageLanguage.
type PreferenceQuranReaderStylesMushafLines ¶
type PreferenceQuranReaderStylesMushafLines string
PreferenceQuranReaderStylesMushafLines defines model for Preference.QuranReaderStyles.MushafLines.
const ( PreferenceQuranReaderStylesMushafLinesN15Lines PreferenceQuranReaderStylesMushafLines = "15_lines" PreferenceQuranReaderStylesMushafLinesN16Lines PreferenceQuranReaderStylesMushafLines = "16_lines" )
Defines values for PreferenceQuranReaderStylesMushafLines.
type PreferenceQuranReaderStylesQuranFont ¶
type PreferenceQuranReaderStylesQuranFont string
PreferenceQuranReaderStylesQuranFont defines model for Preference.QuranReaderStyles.QuranFont.
const ( PreferenceQuranReaderStylesQuranFontCodeV1 PreferenceQuranReaderStylesQuranFont = "code_v1" PreferenceQuranReaderStylesQuranFontCodeV2 PreferenceQuranReaderStylesQuranFont = "code_v2" PreferenceQuranReaderStylesQuranFontQpcUthmaniHafs PreferenceQuranReaderStylesQuranFont = "qpc_uthmani_hafs" PreferenceQuranReaderStylesQuranFontTajweed PreferenceQuranReaderStylesQuranFont = "tajweed" PreferenceQuranReaderStylesQuranFontTajweedV4 PreferenceQuranReaderStylesQuranFont = "tajweed_v4" PreferenceQuranReaderStylesQuranFontTextIndopak PreferenceQuranReaderStylesQuranFont = "text_indopak" PreferenceQuranReaderStylesQuranFontTextUthmani PreferenceQuranReaderStylesQuranFont = "text_uthmani" )
Defines values for PreferenceQuranReaderStylesQuranFont.
type PreferenceReadingReadingPreference ¶
type PreferenceReadingReadingPreference string
PreferenceReadingReadingPreference defines model for Preference.Reading.ReadingPreference.
const ( PreferenceReadingReadingPreferenceReading PreferenceReadingReadingPreference = "reading" PreferenceReadingReadingPreferenceTranslation PreferenceReadingReadingPreference = "translation" )
Defines values for PreferenceReadingReadingPreference.
type PreferenceReadingSelectedWordByWordLocale ¶
type PreferenceReadingSelectedWordByWordLocale string
PreferenceReadingSelectedWordByWordLocale defines model for Preference.Reading.SelectedWordByWordLocale.
const ( PreferenceReadingSelectedWordByWordLocaleBn PreferenceReadingSelectedWordByWordLocale = "bn" PreferenceReadingSelectedWordByWordLocaleDe PreferenceReadingSelectedWordByWordLocale = "de" PreferenceReadingSelectedWordByWordLocaleEn PreferenceReadingSelectedWordByWordLocale = "en" PreferenceReadingSelectedWordByWordLocaleFa PreferenceReadingSelectedWordByWordLocale = "fa" PreferenceReadingSelectedWordByWordLocaleFr PreferenceReadingSelectedWordByWordLocale = "fr" PreferenceReadingSelectedWordByWordLocaleHi PreferenceReadingSelectedWordByWordLocale = "hi" PreferenceReadingSelectedWordByWordLocaleId PreferenceReadingSelectedWordByWordLocale = "id" PreferenceReadingSelectedWordByWordLocaleInh PreferenceReadingSelectedWordByWordLocale = "inh" PreferenceReadingSelectedWordByWordLocaleRu PreferenceReadingSelectedWordByWordLocale = "ru" PreferenceReadingSelectedWordByWordLocaleTa PreferenceReadingSelectedWordByWordLocale = "ta" PreferenceReadingSelectedWordByWordLocaleTr PreferenceReadingSelectedWordByWordLocale = "tr" PreferenceReadingSelectedWordByWordLocaleUr PreferenceReadingSelectedWordByWordLocale = "ur" )
Defines values for PreferenceReadingSelectedWordByWordLocale.
type PreferenceReadingWordByWordContentType ¶
type PreferenceReadingWordByWordContentType string
PreferenceReadingWordByWordContentType defines model for Preference.Reading.WordByWordContentType.
const ( PreferenceReadingWordByWordContentTypeTranslation PreferenceReadingWordByWordContentType = "translation" PreferenceReadingWordByWordContentTypeTransliteration PreferenceReadingWordByWordContentType = "transliteration" )
Defines values for PreferenceReadingWordByWordContentType.
type PreferenceReadingWordByWordDisplay ¶
type PreferenceReadingWordByWordDisplay string
PreferenceReadingWordByWordDisplay defines model for Preference.Reading.WordByWordDisplay.
const ( PreferenceReadingWordByWordDisplayInline PreferenceReadingWordByWordDisplay = "inline" PreferenceReadingWordByWordDisplayTooltip PreferenceReadingWordByWordDisplay = "tooltip" )
Defines values for PreferenceReadingWordByWordDisplay.
type PreferenceReadingWordClickFunctionality ¶
type PreferenceReadingWordClickFunctionality string
PreferenceReadingWordClickFunctionality defines model for Preference.Reading.WordClickFunctionality.
const ( PreferenceReadingWordClickFunctionalityNoAudio PreferenceReadingWordClickFunctionality = "no-audio" PreferenceReadingWordClickFunctionalityPlayAudio PreferenceReadingWordClickFunctionality = "play-audio" )
Defines values for PreferenceReadingWordClickFunctionality.
type PreferenceThemeType ¶
type PreferenceThemeType string
PreferenceThemeType defines model for Preference.Theme.Type.
const ( PreferenceThemeTypeAuto PreferenceThemeType = "auto" PreferenceThemeTypeDark PreferenceThemeType = "dark" PreferenceThemeTypeLight PreferenceThemeType = "light" PreferenceThemeTypeSepia PreferenceThemeType = "sepia" )
Defines values for PreferenceThemeType.
type PutV1CommentsCommentIdJSONBody ¶
type PutV1CommentsCommentIdJSONBody struct {
// Body The updated body of the comment.
Body string `json:"body"`
}
PutV1CommentsCommentIdJSONBody defines parameters for PutV1CommentsCommentId.
type PutV1CommentsCommentIdJSONRequestBody ¶
type PutV1CommentsCommentIdJSONRequestBody PutV1CommentsCommentIdJSONBody
PutV1CommentsCommentIdJSONRequestBody defines body for PutV1CommentsCommentId for application/json ContentType.
type PutV1CommentsCommentIdResponse ¶
type PutV1CommentsCommentIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1CommentsCommentIdResponse ¶
func ParsePutV1CommentsCommentIdResponse(rsp *http.Response) (*PutV1CommentsCommentIdResponse, error)
ParsePutV1CommentsCommentIdResponse parses an HTTP response from a PutV1CommentsCommentIdWithResponse call
func (PutV1CommentsCommentIdResponse) Status ¶
func (r PutV1CommentsCommentIdResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1CommentsCommentIdResponse) StatusCode ¶
func (r PutV1CommentsCommentIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1GoalsIdJSONBody ¶
type PutV1GoalsIdJSONBody struct {
// Amount The amount of the goal. Depending on the goal type, the amount value and format will be different
Amount *PutV1GoalsIdJSONBody_Amount `json:"amount,omitempty"`
// Category The category of the goal
Category *PutV1GoalsIdJSONBodyCategory `json:"category,omitempty"`
// Duration The duration of the goal in days. If it's empty it means the goal is a daily goal and not duration-based.
Duration *int `json:"duration,omitempty"`
// Type The type of the goal.
Type *PutV1GoalsIdJSONBodyType `json:"type,omitempty"`
}
PutV1GoalsIdJSONBody defines parameters for PutV1GoalsId.
type PutV1GoalsIdJSONBodyAmount0 ¶
type PutV1GoalsIdJSONBodyAmount0 = string
PutV1GoalsIdJSONBodyAmount0 defines parameters for PutV1GoalsId.
type PutV1GoalsIdJSONBodyAmount1 ¶
type PutV1GoalsIdJSONBodyAmount1 = int
PutV1GoalsIdJSONBodyAmount1 defines parameters for PutV1GoalsId.
type PutV1GoalsIdJSONBodyCategory ¶
type PutV1GoalsIdJSONBodyCategory string
PutV1GoalsIdJSONBodyCategory defines parameters for PutV1GoalsId.
const ( PutV1GoalsIdJSONBodyCategoryCOURSE PutV1GoalsIdJSONBodyCategory = "COURSE" PutV1GoalsIdJSONBodyCategoryQURAN PutV1GoalsIdJSONBodyCategory = "QURAN" PutV1GoalsIdJSONBodyCategoryQURANREADINGPROGRAM PutV1GoalsIdJSONBodyCategory = "QURAN_READING_PROGRAM" )
Defines values for PutV1GoalsIdJSONBodyCategory.
type PutV1GoalsIdJSONBodyType ¶
type PutV1GoalsIdJSONBodyType string
PutV1GoalsIdJSONBodyType defines parameters for PutV1GoalsId.
const ( COURSE PutV1GoalsIdJSONBodyType = "COURSE" QURANPAGES PutV1GoalsIdJSONBodyType = "QURAN_PAGES" QURANRANGE PutV1GoalsIdJSONBodyType = "QURAN_RANGE" QURANREADINGPROGRAM PutV1GoalsIdJSONBodyType = "QURAN_READING_PROGRAM" QURANTIME PutV1GoalsIdJSONBodyType = "QURAN_TIME" )
Defines values for PutV1GoalsIdJSONBodyType.
type PutV1GoalsIdJSONBody_Amount ¶
type PutV1GoalsIdJSONBody_Amount struct {
// contains filtered or unexported fields
}
PutV1GoalsIdJSONBody_Amount defines parameters for PutV1GoalsId.
type PutV1GoalsIdJSONRequestBody ¶
type PutV1GoalsIdJSONRequestBody PutV1GoalsIdJSONBody
PutV1GoalsIdJSONRequestBody defines body for PutV1GoalsId for application/json ContentType.
type PutV1GoalsIdParams ¶
type PutV1GoalsIdParams struct {
// MushafId The id of the Mushaf being used.
//
// 1 = QCFV2
//
// 2 = QCFV1
//
// 3 = Indopak
//
// 4 = UthmaniHafs
//
// 5 = KFGQPCHAFS
//
// 6 = Indopak15Lines
//
// 7 = Indopak16Lines
//
// 11 = Tajweeed
//
// 19 = QCFTajweedV4
MushafId PutV1GoalsIdParamsMushafId `form:"mushafId" json:"mushafId"`
// XTimezone The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
XTimezone *string `json:"x-timezone,omitempty"`
}
PutV1GoalsIdParams defines parameters for PutV1GoalsId.
type PutV1GoalsIdParamsMushafId ¶
type PutV1GoalsIdParamsMushafId int
PutV1GoalsIdParamsMushafId defines parameters for PutV1GoalsId.
const ( PutV1GoalsIdParamsMushafIdN1 PutV1GoalsIdParamsMushafId = 1 PutV1GoalsIdParamsMushafIdN11 PutV1GoalsIdParamsMushafId = 11 PutV1GoalsIdParamsMushafIdN19 PutV1GoalsIdParamsMushafId = 19 PutV1GoalsIdParamsMushafIdN2 PutV1GoalsIdParamsMushafId = 2 PutV1GoalsIdParamsMushafIdN3 PutV1GoalsIdParamsMushafId = 3 PutV1GoalsIdParamsMushafIdN4 PutV1GoalsIdParamsMushafId = 4 PutV1GoalsIdParamsMushafIdN5 PutV1GoalsIdParamsMushafId = 5 PutV1GoalsIdParamsMushafIdN6 PutV1GoalsIdParamsMushafId = 6 PutV1GoalsIdParamsMushafIdN7 PutV1GoalsIdParamsMushafId = 7 )
Defines values for PutV1GoalsIdParamsMushafId.
type PutV1GoalsIdResponse ¶
type PutV1GoalsIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *map[string]interface{} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1GoalsIdResponse ¶
func ParsePutV1GoalsIdResponse(rsp *http.Response) (*PutV1GoalsIdResponse, error)
ParsePutV1GoalsIdResponse parses an HTTP response from a PutV1GoalsIdWithResponse call
func (PutV1GoalsIdResponse) Status ¶
func (r PutV1GoalsIdResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1GoalsIdResponse) StatusCode ¶
func (r PutV1GoalsIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1GroupsGroupIdAssignAsAdminJSONBody ¶
type PutV1GroupsGroupIdAssignAsAdminJSONBody struct {
// UserId The ID of the user being assigned as an admin.
UserId int `json:"userId"`
}
PutV1GroupsGroupIdAssignAsAdminJSONBody defines parameters for PutV1GroupsGroupIdAssignAsAdmin.
type PutV1GroupsGroupIdAssignAsAdminJSONRequestBody ¶
type PutV1GroupsGroupIdAssignAsAdminJSONRequestBody PutV1GroupsGroupIdAssignAsAdminJSONBody
PutV1GroupsGroupIdAssignAsAdminJSONRequestBody defines body for PutV1GroupsGroupIdAssignAsAdmin for application/json ContentType.
type PutV1GroupsGroupIdAssignAsAdminResponse ¶
type PutV1GroupsGroupIdAssignAsAdminResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1GroupsGroupIdAssignAsAdminResponse ¶
func ParsePutV1GroupsGroupIdAssignAsAdminResponse(rsp *http.Response) (*PutV1GroupsGroupIdAssignAsAdminResponse, error)
ParsePutV1GroupsGroupIdAssignAsAdminResponse parses an HTTP response from a PutV1GroupsGroupIdAssignAsAdminWithResponse call
func (PutV1GroupsGroupIdAssignAsAdminResponse) Status ¶
func (r PutV1GroupsGroupIdAssignAsAdminResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1GroupsGroupIdAssignAsAdminResponse) StatusCode ¶
func (r PutV1GroupsGroupIdAssignAsAdminResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1GroupsGroupIdInviteUserJSONBody ¶
type PutV1GroupsGroupIdInviteUserJSONBody struct {
// Email The email of the user being invited to group.
Email *string `json:"email,omitempty"`
// UserId The ID of the user being invited to group.
UserId *int `json:"userId,omitempty"`
}
PutV1GroupsGroupIdInviteUserJSONBody defines parameters for PutV1GroupsGroupIdInviteUser.
type PutV1GroupsGroupIdInviteUserJSONRequestBody ¶
type PutV1GroupsGroupIdInviteUserJSONRequestBody PutV1GroupsGroupIdInviteUserJSONBody
PutV1GroupsGroupIdInviteUserJSONRequestBody defines body for PutV1GroupsGroupIdInviteUser for application/json ContentType.
type PutV1GroupsGroupIdInviteUserResponse ¶
type PutV1GroupsGroupIdInviteUserResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1GroupsGroupIdInviteUserResponse ¶
func ParsePutV1GroupsGroupIdInviteUserResponse(rsp *http.Response) (*PutV1GroupsGroupIdInviteUserResponse, error)
ParsePutV1GroupsGroupIdInviteUserResponse parses an HTTP response from a PutV1GroupsGroupIdInviteUserWithResponse call
func (PutV1GroupsGroupIdInviteUserResponse) Status ¶
func (r PutV1GroupsGroupIdInviteUserResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1GroupsGroupIdInviteUserResponse) StatusCode ¶
func (r PutV1GroupsGroupIdInviteUserResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1GroupsGroupIdRemoveUserJSONBody ¶
type PutV1GroupsGroupIdRemoveUserJSONBody struct {
// UserId The ID of the user being removed from group.
UserId int `json:"userId"`
}
PutV1GroupsGroupIdRemoveUserJSONBody defines parameters for PutV1GroupsGroupIdRemoveUser.
type PutV1GroupsGroupIdRemoveUserJSONRequestBody ¶
type PutV1GroupsGroupIdRemoveUserJSONRequestBody PutV1GroupsGroupIdRemoveUserJSONBody
PutV1GroupsGroupIdRemoveUserJSONRequestBody defines body for PutV1GroupsGroupIdRemoveUser for application/json ContentType.
type PutV1GroupsGroupIdRemoveUserResponse ¶
type PutV1GroupsGroupIdRemoveUserResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1GroupsGroupIdRemoveUserResponse ¶
func ParsePutV1GroupsGroupIdRemoveUserResponse(rsp *http.Response) (*PutV1GroupsGroupIdRemoveUserResponse, error)
ParsePutV1GroupsGroupIdRemoveUserResponse parses an HTTP response from a PutV1GroupsGroupIdRemoveUserWithResponse call
func (PutV1GroupsGroupIdRemoveUserResponse) Status ¶
func (r PutV1GroupsGroupIdRemoveUserResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1GroupsGroupIdRemoveUserResponse) StatusCode ¶
func (r PutV1GroupsGroupIdRemoveUserResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1PostsPostIdJSONBody ¶
type PutV1PostsPostIdJSONBody struct {
// Body The body of the post.
Body string `json:"body"`
// IsPrivate Whether the post should be posted as a private note.
IsPrivate *bool `json:"isPrivate,omitempty"`
// References The Surahs/Ayahs the post relates to. If `references` is not passed with update post API, existing references of the post will be removed.
References *[]PostReference `json:"references,omitempty"`
// RoomId The Id of the room the post will be posted in.
RoomId *int `json:"roomId,omitempty"`
// TagIds The Ids of the tags the post is attached to
TagIds *[]int `json:"tagIds,omitempty"`
}
PutV1PostsPostIdJSONBody defines parameters for PutV1PostsPostId.
type PutV1PostsPostIdJSONRequestBody ¶
type PutV1PostsPostIdJSONRequestBody PutV1PostsPostIdJSONBody
PutV1PostsPostIdJSONRequestBody defines body for PutV1PostsPostId for application/json ContentType.
type PutV1PostsPostIdResponse ¶
type PutV1PostsPostIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1PostsPostIdResponse ¶
func ParsePutV1PostsPostIdResponse(rsp *http.Response) (*PutV1PostsPostIdResponse, error)
ParsePutV1PostsPostIdResponse parses an HTTP response from a PutV1PostsPostIdWithResponse call
func (PutV1PostsPostIdResponse) Status ¶
func (r PutV1PostsPostIdResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1PostsPostIdResponse) StatusCode ¶
func (r PutV1PostsPostIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1UsersNotificationsSettingIdJSONRequestBody ¶
type PutV1UsersNotificationsSettingIdJSONRequestBody = NotificationSettings
PutV1UsersNotificationsSettingIdJSONRequestBody defines body for PutV1UsersNotificationsSettingId for application/json ContentType.
type PutV1UsersNotificationsSettingIdResponse ¶
type PutV1UsersNotificationsSettingIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1UsersNotificationsSettingIdResponse ¶
func ParsePutV1UsersNotificationsSettingIdResponse(rsp *http.Response) (*PutV1UsersNotificationsSettingIdResponse, error)
ParsePutV1UsersNotificationsSettingIdResponse parses an HTTP response from a PutV1UsersNotificationsSettingIdWithResponse call
func (PutV1UsersNotificationsSettingIdResponse) Status ¶
func (r PutV1UsersNotificationsSettingIdResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1UsersNotificationsSettingIdResponse) StatusCode ¶
func (r PutV1UsersNotificationsSettingIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutV1UsersProfileJSONBody ¶
type PutV1UsersProfileJSONBody struct {
// FirstName The first name of the user.
FirstName string `json:"firstName"`
// LastName The last name of the user.
LastName string `json:"lastName"`
}
PutV1UsersProfileJSONBody defines parameters for PutV1UsersProfile.
type PutV1UsersProfileJSONRequestBody ¶
type PutV1UsersProfileJSONRequestBody PutV1UsersProfileJSONBody
PutV1UsersProfileJSONRequestBody defines body for PutV1UsersProfile for application/json ContentType.
type PutV1UsersProfileResponse ¶
type PutV1UsersProfileResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Data *struct {
Message interface{} `json:"message,omitempty"`
} `json:"data,omitempty"`
Success *bool `json:"success,omitempty"`
}
JSON400 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON401 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON403 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON404 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON422 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON429 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON500 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON502 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON503 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
JSON504 *struct {
Message *string `json:"message,omitempty"`
Success *bool `json:"success,omitempty"`
Type *string `json:"type,omitempty"`
}
}
func ParsePutV1UsersProfileResponse ¶
func ParsePutV1UsersProfileResponse(rsp *http.Response) (*PutV1UsersProfileResponse, error)
ParsePutV1UsersProfileResponse parses an HTTP response from a PutV1UsersProfileWithResponse call
func (PutV1UsersProfileResponse) Status ¶
func (r PutV1UsersProfileResponse) Status() string
Status returns HTTPResponse.Status
func (PutV1UsersProfileResponse) StatusCode ¶
func (r PutV1UsersProfileResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ReadingSession ¶
type ReadingSession struct {
ChapterNumber *int `json:"chapterNumber,omitempty"`
Id string `json:"id"`
UpdatedAt time.Time `json:"updatedAt"`
VerseNumber *int `json:"verseNumber,omitempty"`
}
ReadingSession defines model for ReadingSession.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type Room ¶
type Room struct {
// Active Whether the group is active or not.
Active bool `json:"active"`
// Avatar The avatar of the group.
Avatar string `json:"avatar"`
// CurrentUserIsAdmin Whether the current user is an admin or not.
CurrentUserIsAdmin bool `json:"currentUserIsAdmin"`
// Description The description of the room.
Description string `json:"description"`
// Group The group slug. Will be empty when it is a page.
Group string `json:"group"`
// Id The id of the room.
Id int `json:"id"`
// Link The link of the group/page. Will contain only the base domain when it is a page.
Link string `json:"link"`
// MembersCount The number of members.
MembersCount int `json:"membersCount"`
// Name The name of the room.
Name string `json:"name"`
// PostsCount The number of posts.
PostsCount int `json:"postsCount"`
// Public Whether the group is public or not.
Public bool `json:"public"`
// RoomType The type of the group
RoomType RoomRoomType `json:"roomType"`
// Subdomain The subdomain of the page. Will be empty when it is a group.
Subdomain string `json:"subdomain"`
// Verified Whether the group is verified or not. Will be `true` if it's a page.
Verified bool `json:"verified"`
}
Room defines model for Room.
type RoomPostStatus ¶
type RoomPostStatus string
RoomPostStatus The room post status.
const ( AsRoom RoomPostStatus = "as_room" OnlyMembers RoomPostStatus = "only_members" Publicly RoomPostStatus = "publicly" )
Defines values for RoomPostStatus.
type RoomRoomType ¶
type RoomRoomType string
RoomRoomType The type of the group
const ( RoomRoomTypeGroup RoomRoomType = "group" RoomRoomTypePage RoomRoomType = "page" )
Defines values for RoomRoomType.
type UserProfile ¶
type UserProfile struct {
CreatedAt *time.Time `json:"createdAt,omitempty"`
Email *string `json:"email,omitempty"`
FirstName *string `json:"firstName,omitempty"`
Id *string `json:"id,omitempty"`
LastName *string `json:"lastName,omitempty"`
PhotoUrl *string `json:"photoUrl,omitempty"`
}
UserProfile defines model for UserProfile.