Constructor Detail

Method Detail

• withRawResponse

   abstract WorkspacePreferenceService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract WorkspacePreferenceService withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• topics

   abstract TopicService topics()

• create

   WorkspacePreferenceGetResponse create(WorkspacePreferenceCreateParams params)

  Create a workspace preference. The workspace preference id is generated and returned. Topics are created inside a workspace preference via POST /preferences/sections/{section_id}/topics.

• create

   abstract WorkspacePreferenceGetResponse create(WorkspacePreferenceCreateParams params, RequestOptions requestOptions)

• create

   WorkspacePreferenceGetResponse create(WorkspacePreferenceCreateRequest workspacePreferenceCreateRequest, RequestOptions requestOptions)

• create

   WorkspacePreferenceGetResponse create(WorkspacePreferenceCreateRequest workspacePreferenceCreateRequest)

• retrieve

   WorkspacePreferenceGetResponse retrieve(String sectionId)

  Retrieve a workspace preference by id, including its topics.

• retrieve

   WorkspacePreferenceGetResponse retrieve(String sectionId, WorkspacePreferenceRetrieveParams params, RequestOptions requestOptions)

• retrieve

   WorkspacePreferenceGetResponse retrieve(String sectionId, WorkspacePreferenceRetrieveParams params)

• retrieve

   abstract WorkspacePreferenceGetResponse retrieve(WorkspacePreferenceRetrieveParams params, RequestOptions requestOptions)

• retrieve

   WorkspacePreferenceGetResponse retrieve(WorkspacePreferenceRetrieveParams params)

• retrieve

   WorkspacePreferenceGetResponse retrieve(String sectionId, RequestOptions requestOptions)

• list

   WorkspacePreferenceListResponse list()

  List the workspace's preferences. Each workspace preference embeds its topics. Scoped to the workspace of the API key.

• list

   abstract WorkspacePreferenceListResponse list(WorkspacePreferenceListParams params, RequestOptions requestOptions)

• list

   WorkspacePreferenceListResponse list(WorkspacePreferenceListParams params)

• list

   WorkspacePreferenceListResponse list(RequestOptions requestOptions)

• archive

   Unit archive(String sectionId)

  Archive a workspace preference. The workspace preference must be empty: delete its topics first, otherwise the request fails with 409.

• archive

   Unit archive(String sectionId, WorkspacePreferenceArchiveParams params, RequestOptions requestOptions)

• archive

   Unit archive(String sectionId, WorkspacePreferenceArchiveParams params)

• archive

   abstract Unit archive(WorkspacePreferenceArchiveParams params, RequestOptions requestOptions)

• archive

   Unit archive(WorkspacePreferenceArchiveParams params)

• archive

   Unit archive(String sectionId, RequestOptions requestOptions)

• publish

   PublishPreferencesResponse publish()

  Publish the workspace's preferences page. Takes a snapshot of every workspace preference with its topics under a new published version, making the current state visible on the hosted preferences page (non-draft).

• publish

   abstract PublishPreferencesResponse publish(WorkspacePreferencePublishParams params, RequestOptions requestOptions)

• publish

   PublishPreferencesResponse publish(WorkspacePreferencePublishParams params)

• publish

   PublishPreferencesResponse publish(RequestOptions requestOptions)

• replace

   WorkspacePreferenceGetResponse replace(String sectionId, WorkspacePreferenceReplaceParams params)

  Replace a workspace preference. Full document replacement; missing optional fields are cleared. Topics attached to the workspace preference are unaffected.

• replace

   WorkspacePreferenceGetResponse replace(String sectionId, WorkspacePreferenceReplaceParams params, RequestOptions requestOptions)

• replace

   WorkspacePreferenceGetResponse replace(WorkspacePreferenceReplaceParams params)

• replace

   abstract WorkspacePreferenceGetResponse replace(WorkspacePreferenceReplaceParams params, RequestOptions requestOptions)