nookplusapi

type Article struct {
	// AliasUrl Permanent record-key URL. It never changes, and redirects to the
	// canonical URL, so it is the safe form to embed anywhere durable.
	AliasUrl *string `json:"aliasUrl,omitempty"`

	// Cid Content identifier of the record revision. Send it back as a quoted
	// `If-Match` value to make a mutation conditional. Present on
	// responses that read or write a record.
	//
	//
	// Examples: bafyreiexamplecid
	Cid *CID `json:"cid,omitempty"`

	// Publication AT URI of a record (`at://did/collection/rkey`). Permanent record identity.
	//
	// Examples: at://did:plc:aaaabbbbccccddddeeeeffff/app.nooker.publication/3jt5mavarik22
	Publication AtUri     `json:"publication"`
	PublishedAt time.Time `json:"publishedAt"`

	// Slug Lowercase ASCII letters, digits, and hyphens; no leading or trailing hyphen.
	Slug      Slug       `json:"slug"`
	Title     string     `json:"title"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`

	// Uri AT URI of a record (`at://did/collection/rkey`). Permanent record identity.
	//
	// Examples: at://did:plc:aaaabbbbccccddddeeeeffff/app.nooker.publication/3jt5mavarik22
	Uri AtUri `json:"uri"`

	// Url Canonical public URL as currently served, built from the slug.
	// Clients display and share this value and must not assemble it
	// themselves; the canonical form can change without the record
	// changing.
	Url *string `json:"url,omitempty"`
}

type ArticleInput struct {
	// Content Markdown (CommonMark + GFM tables and strikethrough).
	Content string `json:"content"`

	// Publication AT URI of a record (`at://did/collection/rkey`). Permanent record identity.
	//
	// Examples: at://did:plc:aaaabbbbccccddddeeeeffff/app.nooker.publication/3jt5mavarik22
	Publication AtUri `json:"publication"`

	// PublishedAt Defaults to the server's current time when omitted.
	PublishedAt *time.Time `json:"publishedAt,omitempty"`

	// Slug Lowercase ASCII letters, digits, and hyphens; no leading or trailing hyphen.
	Slug    Slug    `json:"slug"`
	Summary *string `json:"summary,omitempty"`
	Title   string  `json:"title"`
}

type AtUri = string

type BlobRef struct {
	// MimeType Must be one of the types the Lexicon accepts for the field.
	//
	// Examples: image/png
	MimeType string `json:"mimeType"`

	// Ref Content identifier of the record revision. Send it back as a quoted
	// `If-Match` value to make a mutation conditional. Present on
	// responses that read or write a record.
	//
	//
	// Examples: bafyreiexamplecid
	Ref CID `json:"ref"`

	// Size Byte length the repository reported for the stored blob.
	Size int64 `json:"size"`
}

type CID = string

type CheckHandleAvailabilityParams struct {
	// Handle Fully qualified handle to check (for example `alice.handles.example.com`).
	Handle Handle `form:"handle" json:"handle"`
}

type CreateArticleJSONRequestBody = ArticleInput

type CreateArticleParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type CreatePublicationJSONRequestBody = PublicationInput

type CreatePublicationParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type DeleteArticleParams struct {
	// IfMatch The record CID last read by the client. The server forwards it to the
	// PDS as a compare-and-swap, so a record that changed in the meantime is
	// rejected with `record-conflict` (412) and left untouched.
	//
	// A quoted strong entity tag (`"bafyrei…"`) is the preferred form and
	// matches what `ETag` returns. Two further forms are accepted, because a
	// client cannot always produce the first one:
	//
	// - the bare CID: `bafyrei…`
	// - the quoted form with its quotes percent-encoded: `%22bafyrei…%22`
	//
	// The third exists because generated clients commonly serialize a header
	// value as a URI component, which percent-encodes `"`. Such a client
	// feeding an `ETag` straight back sends `%22…%22` and has no way not to.
	// A server MUST accept all three and treat them as the same CID.
	//
	// Omitting the header makes the mutation unconditional. An empty entity
	// tag (`""`) is NOT equivalent to omitting it: it names no CID to compare
	// against, and is rejected with `invalid-request` (400) rather than
	// silently discarding the guarantee this header exists to provide. Any
	// other value is rejected the same way.
	IfMatch *IfMatch `json:"If-Match,omitempty"`
}

type DeleteHostedAccountParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type DeletePublicationParams struct {
	// IfMatch The record CID last read by the client. The server forwards it to the
	// PDS as a compare-and-swap, so a record that changed in the meantime is
	// rejected with `record-conflict` (412) and left untouched.
	//
	// A quoted strong entity tag (`"bafyrei…"`) is the preferred form and
	// matches what `ETag` returns. Two further forms are accepted, because a
	// client cannot always produce the first one:
	//
	// - the bare CID: `bafyrei…`
	// - the quoted form with its quotes percent-encoded: `%22bafyrei…%22`
	//
	// The third exists because generated clients commonly serialize a header
	// value as a URI component, which percent-encodes `"`. Such a client
	// feeding an `ETag` straight back sends `%22…%22` and has no way not to.
	// A server MUST accept all three and treat them as the same CID.
	//
	// Omitting the header makes the mutation unconditional. An empty entity
	// tag (`""`) is NOT equivalent to omitting it: it names no CID to compare
	// against, and is rejected with `invalid-request` (400) rather than
	// silently discarding the guarantee this header exists to provide. Any
	// other value is rejected the same way.
	IfMatch *IfMatch `json:"If-Match,omitempty"`
}

type Did = string

type DisconnectionReceipt struct {
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	CreatedAt   time.Time  `json:"createdAt"`

	// FailureCode Normalised, non-sensitive reason. Present only when failed.
	FailureCode *string `json:"failureCode,omitempty"`
	Id          string  `json:"id"`

	// OwnerDid Decentralized identifier of the member. The stable identifier for all member-scoped data.
	//
	// Examples: did:plc:aaaabbbbccccddddeeeeffff
	OwnerDid Did                        `json:"ownerDid"`
	Status   DisconnectionReceiptStatus `json:"status"`
}

type DisconnectionReceiptStatus string

type ExportJob struct {
	// DownloadUrl Present when completed. Time-limited URL for the export archive.
	DownloadUrl *string         `json:"downloadUrl,omitempty"`
	Id          string          `json:"id"`
	Status      ExportJobStatus `json:"status"`
}

type ExportJobStatus string

type Handle = string

type HostedAccountDeletionInput struct {
	Password string `json:"password"`
}

type IdempotencyKey = string

type IfMatch = string

type Member struct {
	// Did Decentralized identifier of the member. The stable identifier for all member-scoped data.
	//
	// Examples: did:plc:aaaabbbbccccddddeeeeffff
	Did Did `json:"did"`

	// Handle AT Protocol handle. Mutable presentation attribute.
	//
	// Examples: alice.handles.example.com
	Handle Handle `json:"handle"`

	// Status Suspended or revoked members retain access to export and deletion.
	Status MemberStatus `json:"status"`
}

type MemberStatus string

type Problem struct {
	Detail   *string `json:"detail,omitempty"`
	Instance *string `json:"instance,omitempty"`

	// Reason Machine-readable cause, more specific than `type`. Present only when the cause is one a client should phrase in its own words: `detail` is English prose written for a developer reading a log, so a client that shows it to a user shows untranslated text. Clients MUST treat an unrecognised value as absent and fall back to `type`. Values are added additively and never repurposed.
	//
	//
	// Examples: email-already-used
	Reason *ProblemReason `json:"reason,omitempty"`
	Status int            `json:"status"`
	Title  string         `json:"title"`

	// Type URI identifying the error type. Defaults to `about:blank`.
	Type *string `json:"type,omitempty"`
}

type ProblemReason string

type Publication struct {
	// Cid Content identifier of the record revision. Send it back as a quoted
	// `If-Match` value to make a mutation conditional. Present on
	// responses that read or write a record.
	//
	//
	// Examples: bafyreiexamplecid
	Cid         *CID    `json:"cid,omitempty"`
	Description *string `json:"description,omitempty"`

	// Icon Present when the publication carries its own icon.
	Icon *BlobRef `json:"icon,omitempty"`

	// IconUrl Where the icon is served from, once the service has derived its
	// delivery form. Absent until the first render after an upload, and
	// absent entirely for a publication using the service's own mark.
	IconUrl  *string `json:"iconUrl,omitempty"`
	Language string  `json:"language"`
	Name     string  `json:"name"`

	// Slug Lowercase ASCII letters, digits, and hyphens; no leading or trailing hyphen.
	Slug Slug `json:"slug"`

	// Uri AT URI of a record (`at://did/collection/rkey`). Permanent record identity.
	//
	// Examples: at://did:plc:aaaabbbbccccddddeeeeffff/app.nooker.publication/3jt5mavarik22
	Uri  AtUri            `json:"uri"`
	Urls *PublicationUrls `json:"urls,omitempty"`
}

type PublicationInput struct {
	Description *string `json:"description,omitempty"`

	// Icon Icon for the publication. This request replaces the record, so an
	// omitted icon is removed — the same rule `description` already follows.
	// A client editing anything else must send the icon it wants kept.
	Icon *BlobRef `json:"icon,omitempty"`

	// Language BCP-47 language tag.
	Language string `json:"language"`
	Name     string `json:"name"`

	// Slug Lowercase ASCII letters, digits, and hyphens; no leading or trailing hyphen.
	Slug Slug `json:"slug"`
}

type PublicationUrls struct {
	Atom string `json:"atom"`
	Page string `json:"page"`
	Rss  string `json:"rss"`
}

type RecordKey = string

type RequestAccountDeletionParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type RequestExportParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type RequestID = string

type RequestServiceDisconnectionParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type Session struct {
	AccessJwt  string `json:"accessJwt"`
	RefreshJwt string `json:"refreshJwt"`
}

type SignupJSONBody struct {
	DisplayName *string `json:"displayName,omitempty"`

	// Email Recovery email. Forwarded to the PDS.
	Email openapi_types.Email `json:"email"`

	// Handle AT Protocol handle. Mutable presentation attribute.
	//
	// Examples: alice.handles.example.com
	Handle         Handle `json:"handle"`
	InvitationCode string `json:"invitationCode"`

	// Password Forwarded only to the PDS account boundary; never stored or logged by the service.
	Password string `json:"password"`
}

type SignupJSONRequestBody SignupJSONBody

type SignupParams struct {
	// IdempotencyKey Client-generated opaque key (for example a UUID). Retrying a request
	// with the same key MUST NOT repeat its side effects; the server
	// replays the original outcome.
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

type Slug = string

type UpdateArticleJSONRequestBody = ArticleInput

type UpdateArticleParams struct {
	// IfMatch The record CID last read by the client. The server forwards it to the
	// PDS as a compare-and-swap, so a record that changed in the meantime is
	// rejected with `record-conflict` (412) and left untouched.
	//
	// A quoted strong entity tag (`"bafyrei…"`) is the preferred form and
	// matches what `ETag` returns. Two further forms are accepted, because a
	// client cannot always produce the first one:
	//
	// - the bare CID: `bafyrei…`
	// - the quoted form with its quotes percent-encoded: `%22bafyrei…%22`
	//
	// The third exists because generated clients commonly serialize a header
	// value as a URI component, which percent-encodes `"`. Such a client
	// feeding an `ETag` straight back sends `%22…%22` and has no way not to.
	// A server MUST accept all three and treat them as the same CID.
	//
	// Omitting the header makes the mutation unconditional. An empty entity
	// tag (`""`) is NOT equivalent to omitting it: it names no CID to compare
	// against, and is rejected with `invalid-request` (400) rather than
	// silently discarding the guarantee this header exists to provide. Any
	// other value is rejected the same way.
	IfMatch *IfMatch `json:"If-Match,omitempty"`
}

type UpdatePublicationJSONRequestBody = PublicationInput

type UpdatePublicationParams struct {
	// IfMatch The record CID last read by the client. The server forwards it to the
	// PDS as a compare-and-swap, so a record that changed in the meantime is
	// rejected with `record-conflict` (412) and left untouched.
	//
	// A quoted strong entity tag (`"bafyrei…"`) is the preferred form and
	// matches what `ETag` returns. Two further forms are accepted, because a
	// client cannot always produce the first one:
	//
	// - the bare CID: `bafyrei…`
	// - the quoted form with its quotes percent-encoded: `%22bafyrei…%22`
	//
	// The third exists because generated clients commonly serialize a header
	// value as a URI component, which percent-encodes `"`. Such a client
	// feeding an `ETag` straight back sends `%22…%22` and has no way not to.
	// A server MUST accept all three and treat them as the same CID.
	//
	// Omitting the header makes the mutation unconditional. An empty entity
	// tag (`""`) is NOT equivalent to omitting it: it names no CID to compare
	// against, and is rejected with `invalid-request` (400) rather than
	// silently discarding the guarantee this header exists to provide. Any
	// other value is rejected the same way.
	IfMatch *IfMatch `json:"If-Match,omitempty"`
}

type VerifyInvitationJSONBody struct {
	Code string `json:"code"`
}

type VerifyInvitationJSONRequestBody VerifyInvitationJSONBody