Ozone

https://ozone.christian.sh
Admin
Ozone is a Kotlin multiplatform library providing type-safe bindings for the Bluesky API, supporting...
Tokens:508,790
Snippets:4,213
Trust Score:5.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install Function Declaration - Kotlin

Source: https://ozone.christian.sh/ozone/sh.christian.ozone.api/-bluesky-auth-plugin/-companion/index

Provides the 'install' function signature for the Companion object. This function is responsible for installing a BlueskyAuthPlugin instance into a given HttpClient scope.

```kotlin
open override fun install(plugin: BlueskyAuthPlugin, scope: HttpClient)
```

--------------------------------

### Get Starter Pack Query Params

Source: https://ozone.christian.sh/ozone/app.bsky.graph/-get-starter-pack-query-params/-get-starter-pack-query-params

Retrieves starter pack information using query parameters.

```APIDOC
## GET /websites/ozone_christian_sh/starter_pack

### Description
Retrieves the starter pack information based on the provided AT-URI reference.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/starter_pack

### Parameters
#### Query Parameters
- **starterPack** (AT-URI) - Required - Reference (AT-URI) of the starter pack record.

### Request Example
```json
{
  "starterPack": "app.bsky.feed.defs#generatorView"
}
```

### Response
#### Success Response (200)
- **starterPackInfo** (object) - Detailed information about the starter pack.

#### Response Example
```json
{
  "starterPackInfo": {
    "name": "Example Starter Pack",
    "description": "This is an example starter pack."
  }
}
```
```

--------------------------------

### GET /actor/starterPacks

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a list of starter packs created by a specific actor.

```APIDOC
## GET /actor/starterPacks

### Description
Get a list of starter packs created by the actor.

### Method
GET

### Endpoint
/actor/starterPacks

### Parameters
#### Query Parameters
- **params** (GetActorStarterPacksQueryParams) - Required - Query parameters for retrieving starter packs.

### Response
#### Success Response (200)
- **response** (GetActorStarterPacksResponse) - The response containing the list of starter packs.

#### Response Example
```json
{
  "starterPacks": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ]
}
```
```

--------------------------------

### GET /suggested-starter-packs-skeleton-unspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets a skeleton of suggested starter packs, intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks.

```APIDOC
## GET /suggested-starter-packs-skeleton-unspecced

### Description
Get a skeleton of suggested starterpacks. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks

### Method
GET

### Endpoint
/suggested-starter-packs-skeleton-unspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestedStarterPacksSkeletonQueryParams) - Required - Query parameters for fetching suggested starter packs skeleton.

### Response
#### Success Response (200)
- **response** (GetSuggestedStarterPacksSkeletonResponse) - The response object containing the suggested starter packs skeleton.

#### Response Example
{
  "response": "GetSuggestedStarterPacksSkeletonResponse"
}
```

--------------------------------

### GET /websites/ozone_christian_sh/suggested-starter-packs

Source: https://ozone.christian.sh/ozone/app.bsky.unspecced/-get-suggested-starter-packs-query-params/index

Retrieves a list of suggested starter packs. Supports filtering by a limit parameter.

```APIDOC
## GET /websites/ozone_christian_sh/suggested-starter-packs

### Description
Retrieves a list of suggested starter packs. You can specify a limit for the number of results returned.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/suggested-starter-packs

### Parameters
#### Query Parameters
- **limit** (Long) - Optional - The maximum number of suggested starter packs to return. Defaults to 10.

### Request Example
```
GET /websites/ozone_christian_sh/suggested-starter-packs?limit=20
```

### Response
#### Success Response (200)
- **starterPacks** (List<StarterPack>) - A list of suggested starter pack objects.

#### Response Example
```json
{
  "starterPacks": [
    {
      "id": "pack123",
      "name": "Beginner Pack",
      "items": ["itemA", "itemB"]
    },
    {
      "id": "pack456",
      "name": "Advanced Pack",
      "items": ["itemC", "itemD"]
    }
  ]
}
```
```

--------------------------------

### GET /suggestedStarterPacksSkeletonUnspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a skeleton of suggested starter packs. This endpoint is intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks.

```APIDOC
## GET /suggestedStarterPacksSkeletonUnspecced

### Description
Get a skeleton of suggested starterpacks. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks

### Method
GET

### Endpoint
/suggestedStarterPacksSkeletonUnspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestedStarterPacksSkeletonQueryParams) - Required - Query parameters for fetching suggested starter packs skeleton.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetSuggestedStarterPacksSkeletonResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "starterPacks": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "creator": {
            "did": "string",
            "handle": "string"
          },
          "items": [
            {
              "type": "string",
              "uri": "string"
            }
          ]
        }
      ]
    }
  }
}
```
```

--------------------------------

### GET /config

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves details about the Ozone server configuration.

```APIDOC
## GET /config

### Description
Get details about ozone's server configuration.

### Method
GET

### Endpoint
/config

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **response** (GetConfigResponse) - The response containing server configuration details.

#### Response Example
```json
{
  "serverName": "string",
  "version": "string",
  "maxPostsPerFeed": 0
}
```
```

--------------------------------

### GET /listOptions

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Lists settings with optional filtering capabilities.

```APIDOC
## GET /listOptions

### Description
List settings with optional filtering.

### Method
GET

### Endpoint
/listOptions

### Parameters
#### Query Parameters
- **params** (ListOptionsQueryParams) - Required - Parameters for listing and filtering options.

### Response
#### Success Response (200)
- **response** (ListOptionsResponse) - The response containing a list of settings options.

#### Response Example
```json
{
  "response": {
    "options": [
      {
        "name": "theme",
        "value": "dark"
      }
    ]
  }
}
```
```

--------------------------------

### Get Actor Metadata

Source: https://ozone.christian.sh/ozone/chat.bsky.moderation/index

Retrieves metadata about an actor, including messages sent, received, conversations, and conversations started, aggregated by day, month, and all time.

```APIDOC
## GET /websites/ozone_christian_sh/actor/metadata

### Description
Retrieves metadata for a specific actor, including statistics on messages and conversations over different time periods (day, month, all time).

### Method
GET

### Endpoint
/websites/ozone_christian_sh/actor/metadata

### Parameters
#### Query Parameters
- **actor** (Did) - Required - The unique identifier of the actor.
- **day** (GetActorMetadataMetadata) - Optional - Metadata for the current day.
- **month** (GetActorMetadataMetadata) - Optional - Metadata for the current month.
- **all** (GetActorMetadataMetadata) - Optional - Overall metadata.

### Request Example
```json
{
  "actor": "did:example:123",
  "day": {
    "messagesSent": 10,
    "messagesReceived": 5,
    "convos": 2,
    "convosStarted": 1
  },
  "month": {
    "messagesSent": 100,
    "messagesReceived": 50,
    "convos": 20,
    "convosStarted": 10
  },
  "all": {
    "messagesSent": 1000,
    "messagesReceived": 500,
    "convos": 200,
    "convosStarted": 100
  }
}
```

### Response
#### Success Response (200)
- **day** (GetActorMetadataMetadata) - Metadata for the current day.
- **month** (GetActorMetadataMetadata) - Metadata for the current month.
- **all** (GetActorMetadataMetadata) - Overall metadata.

#### Response Example
```json
{
  "day": {
    "messagesSent": 10,
    "messagesReceived": 5,
    "convos": 2,
    "convosStarted": 1
  },
  "month": {
    "messagesSent": 100,
    "messagesReceived": 50,
    "convos": 20,
    "convosStarted": 10
  },
  "all": {
    "messagesSent": 1000,
    "messagesReceived": 500,
    "convos": 200,
    "convosStarted": 100
  }
}
```
```

--------------------------------

### GET /getQuotes

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get a list of quotes for a given post.

```APIDOC
## GET /getQuotes

### Description
Get a list of quotes for a given post.

### Method
GET

### Endpoint
/getQuotes

### Parameters
#### Query Parameters
- **params** (GetQuotesQueryParams) - Required - Parameters for fetching quotes.

### Response
#### Success Response (200)
- **response** (GetQuotesResponse) - The response containing the list of quotes.

#### Response Example
```json
{
  "response": "GetQuotesResponse"
}
```
```

--------------------------------

### GET /websites/ozone_christian_sh/starterpacks

Source: https://ozone.christian.sh/ozone/app.bsky.unspecced/-get-suggested-starter-packs-skeleton-query-params/-get-suggested-starter-packs-skeleton-query-params

Retrieves a skeleton list of suggested starter packs. Supports filtering by viewer DID and limiting the number of results.

```APIDOC
## GET /websites/ozone_christian_sh/starterpacks

### Description
Retrieves a skeleton list of suggested starter packs. This endpoint is useful for fetching initial data structures or pre-defined sets of starter packs.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/starterpacks

### Parameters
#### Query Parameters
- **viewer** (string) - Optional - DID of the account making the request (not included for public/unauthenticated queries).
- **limit** (integer) - Optional - The maximum number of starter packs to return. Defaults to 10.

### Request Example
```
GET /websites/ozone_christian_sh/starterpacks?viewer=did:example:123&limit=5
```

### Response
#### Success Response (200)
- **starterPacks** (array) - A list of suggested starter pack objects.
  - **id** (string) - The unique identifier for the starter pack.
  - **name** (string) - The name of the starter pack.
  - **description** (string) - A brief description of the starter pack.

#### Response Example
```json
{
  "starterPacks": [
    {
      "id": "pack_abc",
      "name": "Beginner Pack",
      "description": "A great starting point for new users."
    },
    {
      "id": "pack_def",
      "name": "Advanced Pack",
      "description": "For users looking for more features."
    }
  ]
}
```
```

--------------------------------

### StarterPackView Constructor

Source: https://ozone.christian.sh/ozone/app.bsky.graph/-starter-pack-view/-starter-pack-view

Initializes a StarterPackView object. It requires essential information like the AtUri, Cid, record content, and creator's profile. Optional parameters include list details, feed generators, user counts, labels, and indexing timestamp.

```Kotlin
constructor( uri: AtUri,  cid: Cid,  record: JsonContent,  creator: ProfileViewBasic,  list: ListViewBasic? = null,  listItemsSample: List<ListItemView> = emptyList(),  feeds: List<GeneratorView> = emptyList(),  joinedWeekCount: Long? = null,  joinedAllTimeCount: Long? = null,  labels: List<Label> = emptyList(),  indexedAt: Timestamp)
```

--------------------------------

### GET /getRecord

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get a single record from a repository. Does not require auth.

```APIDOC
## GET /getRecord (Type 1)

### Description
Get a single record from a repository. Does not require auth.

### Method
GET

### Endpoint
/getRecord

### Parameters
#### Query Parameters
- **params** (GetRecordQueryParams) - Required - Parameters for fetching a record.

### Response
#### Success Response (200)
- **response** (GetRecordResponse) - The response containing the record data.

#### Response Example
```json
{
  "response": "GetRecordResponse"
}
```

## GET /getRecord (Type 2)

### Description
Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.

### Method
GET

### Endpoint
/getRecord

### Parameters
#### Query Parameters
- **params** (GetRecordQueryParams) - Required - Parameters for fetching record data blocks.

### Response
#### Success Response (200)
- **response** (ByteArray) - The response containing record data blocks.

#### Response Example
```json
{
  "response": "ByteArray"
}
```

## GET /getRecord (Type 3)

### Description
Get details about a record.

### Method
GET

### Endpoint
/getRecord

### Parameters
#### Query Parameters
- **params** (GetRecordQueryParams) - Required - Parameters for fetching record details.

### Response
#### Success Response (200)
- **response** (GetRecordResponse) - The response containing record details.

#### Response Example
```json
{
  "response": "GetRecordResponse"
}
```
```

--------------------------------

### Get Suggested Starter Packs List (Unspecced)

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a list of suggested starter packs without specific schema constraints. This Kotlin function is part of the Ozone Christian Sh API.

```kotlin
open suspend override fun getSuggestedStarterPacksUnspecced( params: GetSuggestedStarterPacksQueryParams): AtpResponse<GetSuggestedStarterPacksResponse>
Get a list of suggested starterpacks
```

--------------------------------

### GET /listMembers

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Lists all members with access to the ozone service.

```APIDOC
## GET /listMembers

### Description
List all members with access to the ozone service.

### Method
GET

### Endpoint
/listMembers

### Parameters
#### Query Parameters
- **params** (ListMembersQueryParams) - Required - Parameters for listing members.

### Response
#### Success Response (200)
- **response** (ListMembersResponse) - The response containing a list of members.

#### Response Example
```json
{
  "response": {
    "members": [
      {
        "did": "did:example:admin1",
        "role": "admin"
      }
    ]
  }
}
```
```

--------------------------------

### GET /suggestedStarterPacksUnspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a list of suggested starter packs. This endpoint provides a curated list of starter packs for users.

```APIDOC
## GET /suggestedStarterPacksUnspecced

### Description
Get a list of suggested starterpacks

### Method
GET

### Endpoint
/suggestedStarterPacksUnspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestedStarterPacksQueryParams) - Required - Query parameters for fetching suggested starter packs.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetSuggestedStarterPacksResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "starterPacks": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "creator": {
            "did": "string",
            "handle": "string"
          },
          "items": [
            {
              "type": "string",
              "uri": "string"
            }
          ]
        }
      ]
    }
  }
}
```
```

--------------------------------

### GET /getProfiles

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get detailed profile views of multiple actors.

```APIDOC
## GET /getProfiles

### Description
Get detailed profile views of multiple actors.

### Method
GET

### Endpoint
/getProfiles

### Parameters
#### Query Parameters
- **params** (GetProfilesQueryParams) - Required - Parameters for fetching multiple profiles.

### Response
#### Success Response (200)
- **response** (GetProfilesResponse) - The response containing multiple profile views.

#### Response Example
```json
{
  "response": "GetProfilesResponse"
}
```
```

--------------------------------

### Get Suggested Starter Packs

Source: https://ozone.christian.sh/ozone/app.bsky.unspecced/-get-suggested-starter-packs-skeleton-query-params/index

Retrieves a skeleton list of suggested starter packs. Supports filtering by viewer and limiting the number of results.

```APIDOC
## GET /websites/ozone_christian_sh/suggested-starter-packs

### Description
Retrieves a skeleton list of suggested starter packs. This endpoint allows for specifying a viewer DID and a limit for the number of starter packs to return.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/suggested-starter-packs

### Parameters
#### Query Parameters
- **viewer** (Did) - Optional - DID of the account making the request (not included for public/unauthenticated queries).
- **limit** (Long) - Optional - The maximum number of suggested starter packs to return. Defaults to 10.

### Request Example
```
GET /websites/ozone_christian_sh/suggested-starter-packs?viewer=some_did&limit=20
```

### Response
#### Success Response (200)
- **starterPacks** (List<StarterPackSkeleton>) - A list of suggested starter packs.
- **nextPageToken** (String) - Token for fetching the next page of results.

#### Response Example
```json
{
  "starterPacks": [
    {
      "id": "pack123",
      "name": "Beginner Pack",
      "description": "Get started with essentials.",
      "imageUrl": "http://example.com/image1.png"
    },
    {
      "id": "pack456",
      "name": "Advanced Pack",
      "description": "For experienced users.",
      "imageUrl": "http://example.com/image2.png"
    }
  ],
  "nextPageToken": "next_token_abc"
}
```
```

--------------------------------

### GET /getList

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Gets a 'view' (with additional context) of a specified list.

```APIDOC
## GET /getList

### Description
Gets a 'view' (with additional context) of a specified list.

### Method
GET

### Endpoint
/getList

### Parameters
#### Query Parameters
- **params** (GetListQueryParams) - Required - Parameters for fetching a specific list.

### Response
#### Success Response (200)
- **response** (GetListResponse) - The response containing the list view.

#### Response Example
```json
{
  "response": "GetListResponse"
}
```
```

--------------------------------

### GET /getActorStarterPacks

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Retrieves a list of starter packs created by the actor.

```APIDOC
## GET /getActorStarterPacks

### Description
Get a list of starter packs created by the actor.

### Method
GET

### Endpoint
/getActorStarterPacks

### Parameters
#### Query Parameters
- **params** (GetActorStarterPacksQueryParams) - Required - Query parameters for retrieving starter packs.
  - **actorDid** (string) - Required - The DID of the actor.
  - **limit** (integer) - Optional - The maximum number of starter packs to return.
  - **cursor** (string) - Optional - Cursor for pagination.

### Request Example
```json
{
  "params": {
    "actorDid": "did:plc:actor1",
    "limit": 3
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **data** (GetActorStarterPacksResponse) - The response data containing starter packs.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "starterPacks": [
      {
        "name": "Starter Pack 1",
        "description": "A collection of useful items."
      }
    ],
    "cursor": "nextCursor"
  }
}
```
```

--------------------------------

### GET /getLikes

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get like records which reference a subject (by AT-URI and CID).

```APIDOC
## GET /getLikes

### Description
Get like records which reference a subject (by AT-URI and CID).

### Method
GET

### Endpoint
/getLikes

### Parameters
#### Query Parameters
- **params** (GetLikesQueryParams) - Required - Parameters for fetching likes.

### Response
#### Success Response (200)
- **response** (GetLikesResponse) - The response containing like records.

#### Response Example
```json
{
  "response": "GetLikesResponse"
}
```
```

--------------------------------

### Search Starter Packs

Source: https://ozone.christian.sh/ozone/app.bsky.unspecced/-search-starter-packs-skeleton-query-params/index

Retrieves a list of starter packs based on the provided search query and optional parameters.

```APIDOC
## GET /websites/ozone_christian_sh/search/starter_packs

### Description
This endpoint allows you to search for starter packs. It supports a mandatory search query and optional parameters for filtering and pagination.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/search/starter_packs

### Parameters
#### Query Parameters
- **q** (String) - Required - Search query string. Lucene query syntax is recommended.
- **viewer** (Did) - Optional - DID of the account making the request. Not included for public/unauthenticated queries.
- **limit** (Long) - Optional - The maximum number of results to return. Defaults to 25.
- **cursor** (String) - Optional - An opaque cursor for fetching the next page of results.

### Request Example
```
GET /websites/ozone_christian_sh/search/starter_packs?q=example_query&limit=10&cursor=some_cursor_value
```

### Response
#### Success Response (200)
- **results** (Array) - A list of starter pack objects.
- **next_cursor** (String) - The cursor for the next page of results, if available.

#### Response Example
```json
{
  "results": [
    {
      "id": "starter_pack_1",
      "name": "Starter Pack Alpha",
      "description": "A basic starter pack."
    },
    {
      "id": "starter_pack_2",
      "name": "Starter Pack Beta",
      "description": "An advanced starter pack."
    }
  ],
  "next_cursor": "another_cursor_value"
}
```
```

--------------------------------

### GET /suggestions-skeleton-unspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets a skeleton of suggested actors, intended to be called and then hydrated through app.bsky.actor.getSuggestions.

```APIDOC
## GET /suggestions-skeleton-unspecced

### Description
Get a skeleton of suggested actors. Intended to be called and then hydrated through app.bsky.actor.getSuggestions

### Method
GET

### Endpoint
/suggestions-skeleton-unspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestionsSkeletonQueryParams) - Required - Query parameters for fetching suggestions skeleton.

### Response
#### Success Response (200)
- **response** (GetSuggestionsSkeletonResponse) - The response object containing the suggested actors skeleton.

#### Response Example
{
  "response": "GetSuggestionsSkeletonResponse"
}
```

--------------------------------

### GET /suggested-users-skeleton-unspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets a skeleton of suggested users, intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsers.

```APIDOC
## GET /suggested-users-skeleton-unspecced

### Description
Get a skeleton of suggested users. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsers

### Method
GET

### Endpoint
/suggested-users-skeleton-unspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestedUsersSkeletonQueryParams) - Required - Query parameters for fetching suggested users skeleton.

### Response
#### Success Response (200)
- **response** (GetSuggestedUsersSkeletonResponse) - The response object containing the suggested users skeleton.

#### Response Example
{
  "response": "GetSuggestedUsersSkeletonResponse"
}
```

--------------------------------

### Get Starter Packs Views

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves views for a list of starter packs. This Kotlin function is part of the Ozone Christian Sh API.

```kotlin
open suspend override fun getStarterPacks( params: GetStarterPacksQueryParams): AtpResponse<GetStarterPacksResponse>
Get views for a list of starter packs.
```

--------------------------------

### Get Account Information

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Fetches detailed information about a specific account.

```kotlin
open suspend override fun getAccountInfo( params: GetAccountInfoQueryParams): AtpResponse<GetAccountInfoResponse>
```

--------------------------------

### Get Starter Pack View

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a view of a specific starter pack. This Kotlin function is part of the Ozone Christian Sh API.

```kotlin
open suspend override fun getStarterPack( params: GetStarterPackQueryParams): AtpResponse<GetStarterPackResponse>
Gets a view of a starter pack.
```

--------------------------------

### GET /suggested-feeds-skeleton-unspecced

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets a skeleton of suggested feeds, intended to be called and hydrated by app.bsky.unspecced.getSuggestedFeeds.

```APIDOC
## GET /suggested-feeds-skeleton-unspecced

### Description
Get a skeleton of suggested feeds. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedFeeds

### Method
GET

### Endpoint
/suggested-feeds-skeleton-unspecced

### Parameters
#### Query Parameters
- **params** (GetSuggestedFeedsSkeletonQueryParams) - Required - Query parameters for fetching suggested feeds skeleton.

### Response
#### Success Response (200)
- **response** (GetSuggestedFeedsSkeletonResponse) - The response object containing the suggested feeds skeleton.

#### Response Example
{
  "response": "GetSuggestedFeedsSkeletonResponse"
}
```

--------------------------------

### Search Starter Packs

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Find starter packs matching search criteria. This endpoint does not require authentication and is used for discovering available starter packs.

```kotlin
open suspend override fun searchStarterPacks( params: SearchStarterPacksQueryParams): AtpResponse<SearchStarterPacksResponse>
```

--------------------------------

### GET /getListBlocks

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get mod lists that the requesting account (actor) is blocking. Requires auth.

```APIDOC
## GET /getListBlocks

### Description
Get mod lists that the requesting account (actor) is blocking. Requires auth.

### Method
GET

### Endpoint
/getListBlocks

### Parameters
#### Query Parameters
- **params** (GetListBlocksQueryParams) - Required - Parameters for fetching blocked lists.

### Response
#### Success Response (200)
- **response** (GetListBlocksResponse) - The response containing blocked lists.

#### Response Example
```json
{
  "response": "GetListBlocksResponse"
}
```
```

--------------------------------

### StarterPackView Data Structure Definition (Kotlin)

Source: https://ozone.christian.sh/ozone/app.bsky.graph/index

Provides a detailed view of a starter pack, including its URI, CID, record content, creator information, associated list view, sample list items, feeds, join counts, labels, and indexing timestamp. This is used for displaying comprehensive starter pack details.

```kotlin
@Serializable
data class StarterPackView(
  val uri: AtUri,
  val cid: Cid,
  val record: JsonContent,
  val creator: ProfileViewBasic,
  val list: ListViewBasic? = null,
  val listItemsSample: List<ListItemView> = emptyList(),
  val feeds: List<GeneratorView> = emptyList(),
  val joinedWeekCount: Long? = null,
  val joinedAllTimeCount: Long? = null,
  val labels: List<Label> = emptyList(),
  val indexedAt: Timestamp
)
```

--------------------------------

### GET /getLatestCommit

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get the current commit CID & revision of the specified repo. Does not require auth.

```APIDOC
## GET /getLatestCommit

### Description
Get the current commit CID & revision of the specified repo. Does not require auth.

### Method
GET

### Endpoint
/getLatestCommit

### Parameters
#### Query Parameters
- **params** (GetLatestCommitQueryParams) - Required - Parameters for fetching the latest commit.

### Response
#### Success Response (200)
- **response** (GetLatestCommitResponse) - The response containing the latest commit information.

#### Response Example
```json
{
  "response": "GetLatestCommitResponse"
}
```
```

--------------------------------

### StarterPackViewBasic Constructor Parameters (Kotlin)

Source: https://ozone.christian.sh/ozone/app.bsky.graph/-starter-pack-view-basic/-starter-pack-view-basic

The constructor for StarterPackViewBasic requires an AtUri, Cid, JsonContent record, and ProfileViewBasic creator. Optional parameters include listItemCount, joinedWeekCount, joinedAllTimeCount, labels, and indexedAt. These parameters are used to fully define a starter pack view.

```kotlin
constructor( uri: AtUri,  cid: Cid,  record: JsonContent,  creator: ProfileViewBasic,  listItemCount: Long? = null,  joinedWeekCount: Long? = null,  joinedAllTimeCount: Long? = null,  labels: List<Label> = emptyList(),  indexedAt: Timestamp)
```

--------------------------------

### GET /repoStatus

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Gets the hosting status for a repository on the current server. This endpoint is expected to be implemented by PDS and Relay.

```APIDOC
## GET /repoStatus

### Description
Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.

### Method
GET

### Endpoint
/repoStatus

### Parameters
#### Query Parameters
- **params** (GetRepoStatusQueryParams) - Required - Query parameters for fetching repository status.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetRepoStatusResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "repo": "string",
      "status": "string"
    }
  }
}
```
```

--------------------------------

### Get Multiple Account Information

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves detailed information for a list of specified accounts.

```kotlin
open suspend override fun getAccountInfos( params: GetAccountInfosQueryParams): AtpResponse<GetAccountInfosResponse>
```

--------------------------------

### Search Starter Packs Skeleton

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Backend Starter Pack search, returns only skeleton.

```APIDOC
## POST /search/starter_packs/skeleton

### Description
Backend Starter Pack search, returns only skeleton.

### Method
POST

### Endpoint
/search/starter_packs/skeleton

### Parameters
#### Request Body
- **params** (SearchStarterPacksSkeletonQueryParams) - Required - Query parameters for skeleton search of starter packs.

### Response
#### Success Response (200)
- **skeleton** (SearchStarterPacksSkeletonResponse) - The skeleton response for starter pack search.
```

--------------------------------

### GET /getProfile

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

```APIDOC
## GET /getProfile

### Description
Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

### Method
GET

### Endpoint
/getProfile

### Parameters
#### Query Parameters
- **params** (GetProfileQueryParams) - Required - Parameters for fetching a profile.

### Response
#### Success Response (200)
- **response** (GetProfileResponse) - The response containing the profile view.

#### Response Example
```json
{
  "response": "GetProfileResponse"
}
```
```

--------------------------------

### Search Starter Packs Skeleton

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Backend search for starter packs that returns only a skeleton response. This is likely used for performance optimization or initial loading states.

```kotlin
open suspend override fun searchStarterPacksSkeletonUnspecced( params: SearchStarterPacksSkeletonQueryParams): AtpResponse<SearchStarterPacksSkeletonResponse>
```

--------------------------------

### GET /getPostThread

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.

```APIDOC
## GET /getPostThread

### Description
Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.

### Method
GET

### Endpoint
/getPostThread

### Parameters
#### Query Parameters
- **params** (GetPostThreadQueryParams) - Required - Parameters for fetching a post thread.

### Response
#### Success Response (200)
- **response** (GetPostThreadResponse) - The response containing posts in the thread.

#### Response Example
```json
{
  "response": "GetPostThreadResponse"
}
```
```

--------------------------------

### GET /getListFeed

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.

```APIDOC
## GET /getListFeed

### Description
Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.

### Method
GET

### Endpoint
/getListFeed

### Parameters
#### Query Parameters
- **params** (GetListFeedQueryParams) - Required - Parameters for fetching the list feed.

### Response
#### Success Response (200)
- **response** (GetListFeedResponse) - The response containing the list feed.

#### Response Example
```json
{
  "response": "GetListFeedResponse"
}
```
```

--------------------------------

### GET /starterPacks

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves views for a list of starter packs. This endpoint provides summary information for multiple starter packs.

```APIDOC
## GET /starterPacks

### Description
Get views for a list of starter packs.

### Method
GET

### Endpoint
/starterPacks

### Parameters
#### Query Parameters
- **params** (GetStarterPacksQueryParams) - Required - Query parameters for fetching starter packs.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetStarterPacksResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "starterPacks": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "creator": {
            "did": "string",
            "handle": "string"
          },
          "items": [
            {
              "type": "string",
              "uri": "string"
            }
          ]
        }
      ]
    }
  }
}
```
```

--------------------------------

### GET /getPosts

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.

```APIDOC
## GET /getPosts

### Description
Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.

### Method
GET

### Endpoint
/getPosts

### Parameters
#### Query Parameters
- **params** (GetPostsQueryParams) - Required - Parameters for fetching posts.

### Response
#### Success Response (200)
- **response** (GetPostsResponse) - The response containing post views.

#### Response Example
```json
{
  "response": "GetPostsResponse"
}
```
```

--------------------------------

### GET /repo (details)

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves details about a repository. This endpoint provides information about a specific repository.

```APIDOC
## GET /repo (details)

### Description
Get details about a repository.

### Method
GET

### Endpoint
/repo

### Parameters
#### Query Parameters
- **params** (GetRepoQueryParams) - Required - Query parameters for fetching repository details.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetRepoResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "repo": "string",
      "collection": "string",
      "handle": "string",
      "did": "string",
      "cursor": "string",
      "totalCount": 0,
      "viewer": {
        "repostCount": 0,
        "likeCount": 0
      }
    }
  }
}
```
```

--------------------------------

### GET /subjectStatus

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Gets the service-specific admin status of a subject (account, record, or blob). This endpoint provides administrative status information.

```APIDOC
## GET /subjectStatus

### Description
Get the service-specific admin status of a subject (account, record, or blob).

### Method
GET

### Endpoint
/subjectStatus

### Parameters
#### Query Parameters
- **params** (GetSubjectStatusQueryParams) - Required - Query parameters for fetching subject status.

### Response
#### Success Response (200)
- **AtpResponse** (object) - Response containing GetSubjectStatusResponse.

#### Response Example
```json
{
  "atpResponse": {
    "data": {
      "subject": "string",
      "status": "string"
    }
  }
}
```
```

--------------------------------

### BskyAppStatePref Constructor

Source: https://ozone.christian.sh/ozone/app.bsky.actor/-bsky-app-state-pref/-bsky-app-state-pref

Initializes the BskyAppStatePref object. It accepts an optional active progress guide, a list of strings representing queued nudge tokens, and a list of Nux objects for encountered NUXs.

```kotlin
constructor( activeProgressGuide: BskyAppProgressGuide? = null,  queuedNudges: List<String> = emptyList(),  nuxs: List<Nux> = emptyList())
```

--------------------------------

### Get Suggested Starter Packs Skeleton (Unspecced)

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves a skeleton of suggested starter packs, intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks. This Kotlin function is part of the Ozone Christian Sh API.

```kotlin
open suspend override fun getSuggestedStarterPacksSkeletonUnspecced( params: GetSuggestedStarterPacksSkeletonQueryParams): AtpResponse<GetSuggestedStarterPacksSkeletonResponse>
Get a skeleton of suggested starterpacks. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks
```

--------------------------------

### GET /subject-status

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets the service-specific admin status of a subject (account, record, or blob). This endpoint is used for checking subject status.

```APIDOC
## GET /subject-status

### Description
Get the service-specific admin status of a subject (account, record, or blob).

### Method
GET

### Endpoint
/subject-status

### Parameters
#### Query Parameters
- **params** (GetSubjectStatusQueryParams) - Required - Query parameters for fetching subject status.

### Response
#### Success Response (200)
- **response** (GetSubjectStatusResponse) - The response object containing the subject's status.

#### Response Example
{
  "response": "GetSubjectStatusResponse"
}
```

--------------------------------

### Get String Value of ListConvosReadState (Kotlin)

Source: https://ozone.christian.sh/ozone/chat.bsky.convo/-list-convos-read-state/index

Provides a way to get the string representation of a ListConvosReadState. This function is overridden from the base AtpEnum class.

```kotlin
open override val value: String
```

```kotlin
open override fun toString(): String
```

--------------------------------

### GET /starter-packs

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Fetches views for a list of starter packs. This endpoint is useful for discovering and displaying multiple starter packs.

```APIDOC
## GET /starter-packs

### Description
Get views for a list of starter packs.

### Method
GET

### Endpoint
/starter-packs

### Parameters
#### Query Parameters
- **params** (GetStarterPacksQueryParams) - Required - Query parameters for fetching starter pack views.

### Response
#### Success Response (200)
- **response** (GetStarterPacksResponse) - The response object containing views for a list of starter packs.

#### Response Example
{
  "response": "GetStarterPacksResponse"
}
```

--------------------------------

### StarterPackViewBasic Data Structure Definition (Kotlin)

Source: https://ozone.christian.sh/ozone/app.bsky.graph/index

A basic view of a starter pack, containing essential information like URI, CID, record content, creator, item count, join counts, labels, and indexing timestamp. Optimized for list displays where full details are not needed.

```kotlin
@Serializable
data class StarterPackViewBasic(
  val uri: AtUri,
  val cid: Cid,
  val record: JsonContent,
  val creator: ProfileViewBasic,
  val listItemCount: Long? = null,
  val joinedWeekCount: Long? = null,
  val joinedAllTimeCount: Long? = null,
  val labels: List<Label> = emptyList(),
  val indexedAt: Timestamp
)
```

--------------------------------

### Cid Properties and Methods (Kotlin)

Source: https://ozone.christian.sh/ozone/sh.christian.ozone.api/-cid/index

Details the properties and methods available for the Cid class, including the 'cid' property to access the string value, 'length' to get the number of characters, 'get' to access a character by index, 'subSequence' to extract a portion of the CID, and 'toString' to get the string representation.

```kotlin
val cid: String

open override val length: Int

open operator override fun get(index: Int): Char

open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

open override fun toString(): String
```

--------------------------------

### GET /getPreferences

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

```APIDOC
## GET /getPreferences

### Description
Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

### Method
GET

### Endpoint
/getPreferences

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **response** (GetPreferencesResponse) - The response containing private preferences.

#### Response Example
```json
{
  "response": "GetPreferencesResponse"
}
```
```

--------------------------------

### SearchStarterPacksSkeletonQueryParams

Source: https://ozone.christian.sh/ozone/app.bsky.unspecced/-search-starter-packs-skeleton-query-params/-search-starter-packs-skeleton-query-params

This endpoint allows searching for starter packs. It accepts a search query string and optional parameters for viewer identification and pagination.

```APIDOC
## GET /websites/ozone_christian_sh/searchStarterPacks

### Description
Allows searching for starter packs using a query string and optional parameters.

### Method
GET

### Endpoint
/websites/ozone_christian_sh/searchStarterPacks

### Parameters
#### Query Parameters
- **q** (String) - Required - Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.
- **viewer** (Did) - Optional - DID of the account making the request (not included for public/unauthenticated queries).
- **limit** (Long) - Optional - The maximum number of results to return. Defaults to 25.
- **cursor** (String) - Optional - Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

### Request Example
```json
{
  "q": "example search query",
  "viewer": "did:example:123",
  "limit": 50,
  "cursor": "next_page_cursor"
}
```

### Response
#### Success Response (200)
- **results** (Array) - A list of starter packs matching the query.
- **next_cursor** (String) - A cursor for fetching the next page of results, if available.

#### Response Example
```json
{
  "results": [
    {
      "id": "starter_pack_1",
      "name": "Starter Pack Alpha",
      "description": "A basic starter pack."
    },
    {
      "id": "starter_pack_2",
      "name": "Starter Pack Beta",
      "description": "An advanced starter pack."
    }
  ],
  "next_cursor": "another_cursor"
}
```
```

--------------------------------

### Tid Functions: get and subSequence (Kotlin)

Source: https://ozone.christian.sh/ozone/sh.christian.ozone.api/-tid/index

Shows the implementation of the 'get' function to retrieve a character at a specific index and 'subSequence' to extract a portion of the Tid string, both inherited from CharSequence.

```kotlin
open operator override fun get(index: Int): Char
open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence
```

--------------------------------

### SearchStarterPacksQueryParams Data Structure Definition (Kotlin)

Source: https://ozone.christian.sh/ozone/app.bsky.graph/index

Defines query parameters for searching starter packs, including the search query string 'q', an optional limit for results, and a cursor for pagination.

```kotlin
@Serializable
data class SearchStarterPacksQueryParams(
  val q: String,
  val limit: Long? = 25,
  val cursor: String? = null
)
```

--------------------------------

### Define GetStarterPackQueryParams in Kotlin

Source: https://ozone.christian.sh/ozone/app.bsky.graph/index

Defines the query parameters for fetching a single starter pack. It requires the unique URI of the starter pack.

```kotlin
@Serializable
data class GetStarterPackQueryParams(val starterPack: AtUri)
```

--------------------------------

### Get Subject Status

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-bluesky-api/index

Gets the service-specific admin status of a subject (account, record, or blob). This function takes subject status query parameters and returns an AtpResponse with the status.

```kotlin
abstract suspend fun getSubjectStatus( params: GetSubjectStatusQueryParams): AtpResponse<GetSubjectStatusResponse>
```

--------------------------------

### Initialize SearchStarterPacksQueryParams

Source: https://ozone.christian.sh/ozone/app.bsky.graph/-search-starter-packs-query-params/-search-starter-packs-query-params

Constructs a SearchStarterPacksQueryParams object. It requires a search query string 'q' and optionally accepts 'limit' and 'cursor' parameters. The 'q' parameter is a string for the search query, with Lucene query syntax recommended. 'limit' defaults to 25 and 'cursor' defaults to null.

```kotlin
constructor(q: String, limit: Long? = 25, cursor: String? = null)
```

--------------------------------

### GET /getMessages

Source: https://ozone.christian.sh/ozone/sh.christian.ozone/-xrpc-bluesky-api/index

Retrieves messages.

```APIDOC
## GET /getMessages

### Description
Retrieves messages.

### Method
GET

### Endpoint
/getMessages

### Parameters
#### Query Parameters
- **params** (GetMessagesQueryParams) - Required - Parameters for fetching messages.

### Response
#### Success Response (200)
- **response** (GetMessagesResponse) - The response containing messages.

#### Response Example
```json
{
  "response": "GetMessagesResponse"
}
```
```
Tokens:
Raw