gen

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package gen provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Package gen contains the low-level, spec-driven layer of the Lunogram Go SDK.

The types in client.gen.go are generated from the vendored OpenAPI spec (../spec/client.yaml) with oapi-codegen. Do not edit them by hand; run `go generate ./...` (or `make generate`) to regenerate after the spec changes. See spec/SOURCE.md for the spec's source and pinned ref.

The hand-written facade in the root package builds on these types; see the package documentation there for the public API.

Index

Constants

View Source 
const (
	HttpBearerAuthScopes hTTPBearerAuthContextKey = "HttpBearerAuth.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddOrganizationUserClientJSONRequestBody 

type AddOrganizationUserClientJSONRequestBody = OrganizationUserRequest

AddOrganizationUserClientJSONRequestBody defines body for AddOrganizationUserClient for application/json ContentType.

type Channel 

type Channel string

Channel defines model for Channel. 

const (
	Email Channel = "email"
	Inbox Channel = "inbox"
	Push  Channel = "push"
	Sms   Channel = "sms"
)

Defines values for Channel.

func (Channel) Valid 

func (e Channel) Valid() bool

Valid indicates whether the value is a known member of the Channel enum.

type CreateSession 

type CreateSession struct {
	// UserID The end user's external identifier (the session subject).
	UserID string `json:"user_id"`
}

CreateSession Request to mint a session token for an end user.

type CreateSessionJSONRequestBody 

type CreateSessionJSONRequestBody = CreateSession

CreateSessionJSONRequestBody defines body for CreateSession for application/json ContentType.

type DeleteOrganizationClientJSONRequestBody 

type DeleteOrganizationClientJSONRequestBody = DeleteOrganizationRequest

DeleteOrganizationClientJSONRequestBody defines body for DeleteOrganizationClient for application/json ContentType.

type DeleteOrganizationRequest 

type DeleteOrganizationRequest struct {
	// Identifier One or more external identifiers to identify the organization
	Identifier OrganizationIdentifier `json:"identifier"`
}

DeleteOrganizationRequest defines model for DeleteOrganizationRequest.

type DeleteOrganizationScheduledClientJSONRequestBody 

type DeleteOrganizationScheduledClientJSONRequestBody = DeleteOrganizationScheduledRequest

DeleteOrganizationScheduledClientJSONRequestBody defines body for DeleteOrganizationScheduledClient for application/json ContentType.

type DeleteOrganizationScheduledRequest 

type DeleteOrganizationScheduledRequest struct {
	// ID The id of a specific schedule assignment to delete. When provided, only that instance is removed. Either id or name is required.
	ID *openapi_types.UUID `json:"id,omitempty"`

	// Identifier One or more external identifiers to identify the organization
	Identifier OrganizationIdentifier `json:"identifier"`

	// Name The name of the scheduled resource to delete. When provided (and id is omitted), every assignment with this name for the organization is removed. Either id or name is required.
	Name *string `json:"name,omitempty"`
}

DeleteOrganizationScheduledRequest defines model for DeleteOrganizationScheduledRequest.

type DeleteUserClientJSONRequestBody 

type DeleteUserClientJSONRequestBody = DeleteUserRequest

DeleteUserClientJSONRequestBody defines body for DeleteUserClient for application/json ContentType.

type DeleteUserRequest 

type DeleteUserRequest struct {
	// Identifier One or more external identifiers to identify the user
	Identifier UserIdentifier `json:"identifier"`
}

DeleteUserRequest defines model for DeleteUserRequest.

type DeleteUserScheduledClientJSONRequestBody 

type DeleteUserScheduledClientJSONRequestBody = DeleteUserScheduledRequest

DeleteUserScheduledClientJSONRequestBody defines body for DeleteUserScheduledClient for application/json ContentType.

type DeleteUserScheduledRequest 

type DeleteUserScheduledRequest struct {
	// ID The id of a specific schedule assignment to delete. When provided, only that instance is removed. Either id or name is required.
	ID *openapi_types.UUID `json:"id,omitempty"`

	// Identifier One or more external identifiers to identify the user
	Identifier UserIdentifier `json:"identifier"`

	// Name The name of the scheduled resource to delete. When provided (and id is omitted), every assignment with this name for the user is removed. Either id or name is required.
	Name *string `json:"name,omitempty"`
}

DeleteUserScheduledRequest defines model for DeleteUserScheduledRequest.

type DeviceRegistration 

type DeviceRegistration struct {
	AppVersion *string `json:"app_version,omitempty"`
	Config     struct {
		// Endpoint Web Push subscription endpoint URL
		Endpoint       *string    `json:"endpoint,omitempty"`
		ExpirationTime *time.Time `json:"expiration_time,omitempty"`
		Keys           *struct {
			Auth   string `json:"auth"`
			P256Dh string `json:"p256dh"`
		} `json:"keys,omitempty"`

		// Token Device token for FCM or APNs
		Token *string `json:"token,omitempty"`
	} `json:"config"`
	Data     *json.RawMessage `json:"data,omitempty"`
	DeviceID string           `json:"device_id"`

	// Identifier One or more external identifiers to identify the user
	Identifier UserIdentifier        `json:"identifier"`
	Model      *string               `json:"model,omitempty"`
	Os         *DeviceRegistrationOs `json:"os,omitempty"`
	OsVersion  *string               `json:"os_version,omitempty"`
}

DeviceRegistration defines model for DeviceRegistration.

type DeviceRegistrationOs 

type DeviceRegistrationOs string

DeviceRegistrationOs defines model for DeviceRegistration.Os. 

const (
	Android DeviceRegistrationOs = "android"
	Ios     DeviceRegistrationOs = "ios"
	Web     DeviceRegistrationOs = "web"
)

Defines values for DeviceRegistrationOs.

func (DeviceRegistrationOs) Valid 

func (e DeviceRegistrationOs) Valid() bool

Valid indicates whether the value is a known member of the DeviceRegistrationOs enum.

type EmailUnsubscribeParams 

type EmailUnsubscribeParams struct {
	// Link Encoded unsubscribe link with user and campaign data
	Link string `form:"link" json:"link"`
}

EmailUnsubscribeParams defines parameters for EmailUnsubscribe.

type Error 

type Error = Problem

Error defines model for Error.

type Event 

type Event struct {
	// Data Event-specific data
	Data map[string]any `json:"data"`

	// Identifier One or more external identifiers to identify the user
	Identifier *UserIdentifier `json:"identifier,omitempty"`

	// Match JSONB containment filter to match users by their data attributes. Mutually exclusive with identifier. When set, the event is delivered to every user whose data column contains the given key/value pairs.
	Match *map[string]any `json:"match,omitempty"`

	// Name The name of the event
	Name string `json:"name"`
}

Event defines model for Event.

type ExternalID 

type ExternalID struct {
	// ExternalID The external identifier value
	ExternalID string `json:"external_id"`

	// Metadata Optional metadata associated with this identifier
	Metadata *map[string]any `json:"metadata,omitempty"`

	// Source Source of the identifier (e.g. "default", "anonymous", or a custom source). Defaults to "default" if not provided.
	Source *string `json:"source,omitempty"`
}

ExternalID An external identifier with source and optional metadata

type ExternalIDResponse 

type ExternalIDResponse struct {
	CreatedAt  time.Time          `json:"created_at"`
	ExternalID string             `json:"external_id"`
	ID         openapi_types.UUID `json:"id"`
	Metadata   *map[string]any    `json:"metadata,omitempty"`
	Source     string             `json:"source"`
	UpdatedAt  time.Time          `json:"updated_at"`
}

ExternalIDResponse An external identifier as returned in responses, including database ID and timestamps

type GetOrganizationInboxCountParams 

type GetOrganizationInboxCountParams struct {
	Source     string  `form:"source" json:"source"`
	ExternalID string  `form:"external_id" json:"external_id"`
	Channel    Channel `form:"channel" json:"channel"`
}

GetOrganizationInboxCountParams defines parameters for GetOrganizationInboxCount.

type GetOrganizationInboxParams 

type GetOrganizationInboxParams struct {
	Source     string                            `form:"source" json:"source"`
	ExternalID string                            `form:"external_id" json:"external_id"`
	Status     *GetOrganizationInboxParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Tags Comma-separated tag filter. All listed tags must be present.
	Tags          *string `form:"tags,omitempty" json:"tags,omitempty"`
	MessageSource *string `form:"message_source,omitempty" json:"message_source,omitempty"`
	Priority      *int    `form:"priority,omitempty" json:"priority,omitempty"`
	Channel       Channel `form:"channel" json:"channel"`

	// Limit Maximum number of items to return
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip
	Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}

GetOrganizationInboxParams defines parameters for GetOrganizationInbox.

type GetOrganizationInboxParamsStatus 

type GetOrganizationInboxParamsStatus string

GetOrganizationInboxParamsStatus defines parameters for GetOrganizationInbox. 

const (
	GetOrganizationInboxParamsStatusArchived GetOrganizationInboxParamsStatus = "archived"
	GetOrganizationInboxParamsStatusRead     GetOrganizationInboxParamsStatus = "read"
	GetOrganizationInboxParamsStatusUnread   GetOrganizationInboxParamsStatus = "unread"
)

Defines values for GetOrganizationInboxParamsStatus.

func (GetOrganizationInboxParamsStatus) Valid 

func (e GetOrganizationInboxParamsStatus) Valid() bool

Valid indicates whether the value is a known member of the GetOrganizationInboxParamsStatus enum.

type GetUserInboxCountParams 

type GetUserInboxCountParams struct {
	Source     string  `form:"source" json:"source"`
	ExternalID string  `form:"external_id" json:"external_id"`
	Channel    Channel `form:"channel" json:"channel"`
}

GetUserInboxCountParams defines parameters for GetUserInboxCount.

type GetUserInboxParams 

type GetUserInboxParams struct {
	Source     string                    `form:"source" json:"source"`
	ExternalID string                    `form:"external_id" json:"external_id"`
	Status     *GetUserInboxParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Tags Comma-separated tag filter. All listed tags must be present.
	Tags          *string `form:"tags,omitempty" json:"tags,omitempty"`
	MessageSource *string `form:"message_source,omitempty" json:"message_source,omitempty"`
	Priority      *int    `form:"priority,omitempty" json:"priority,omitempty"`
	Channel       Channel `form:"channel" json:"channel"`

	// Limit Maximum number of items to return
	Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip
	Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}

GetUserInboxParams defines parameters for GetUserInbox.

type GetUserInboxParamsStatus 

type GetUserInboxParamsStatus string

GetUserInboxParamsStatus defines parameters for GetUserInbox. 

const (
	GetUserInboxParamsStatusArchived GetUserInboxParamsStatus = "archived"
	GetUserInboxParamsStatusRead     GetUserInboxParamsStatus = "read"
	GetUserInboxParamsStatusUnread   GetUserInboxParamsStatus = "unread"
)

Defines values for GetUserInboxParamsStatus.

func (GetUserInboxParamsStatus) Valid 

func (e GetUserInboxParamsStatus) Valid() bool

Valid indicates whether the value is a known member of the GetUserInboxParamsStatus enum.

type IdentifyRequest 

type IdentifyRequest struct {
	// Data User-specific attributes
	Data  *map[string]any `json:"data,omitempty"`
	Email *string         `json:"email,omitempty"`

	// Identifier One or more external identifiers to identify the user
	Identifier UserIdentifier `json:"identifier"`
	Locale     *string        `json:"locale,omitempty"`

	// Phone E.164 formatted phone number
	Phone    *string `json:"phone,omitempty"`
	Timezone *string `json:"timezone,omitempty"`
}

IdentifyRequest defines model for IdentifyRequest.

type InboxCount 

type InboxCount struct {
	Total  int `json:"total"`
	Unread int `json:"unread"`
}

InboxCount defines model for InboxCount.

type InboxMessage 

type InboxMessage struct {
	ArchivedAt  *time.Time          `json:"archived_at,omitempty"`
	BroadcastID *openapi_types.UUID `json:"broadcast_id,omitempty"`
	CampaignID  *openapi_types.UUID `json:"campaign_id,omitempty"`
	Channel     Channel             `json:"channel"`
	Content     json.RawMessage     `json:"content"`
	CreatedAt   time.Time           `json:"created_at"`
	Data        json.RawMessage     `json:"data"`
	ExpiresAt   *time.Time          `json:"expires_at,omitempty"`

	// ExternalID External identifier for the message, if one was provided at creation time.
	ExternalID       *string             `json:"external_id,omitempty"`
	ID               openapi_types.UUID  `json:"id"`
	OrganizationID   *openapi_types.UUID `json:"organization_id,omitempty"`
	Priority         int16               `json:"priority"`
	ProjectID        openapi_types.UUID  `json:"project_id"`
	ReadAt           *time.Time          `json:"read_at,omitempty"`
	ScheduledAt      time.Time           `json:"scheduled_at"`
	SenderIdentityID *openapi_types.UUID `json:"sender_identity_id,omitempty"`
	SentAt           *time.Time          `json:"sent_at,omitempty"`
	Source           *string             `json:"source,omitempty"`
	Tags             []string            `json:"tags"`
	UpdatedAt        time.Time           `json:"updated_at"`
	UserID           *openapi_types.UUID `json:"user_id,omitempty"`
}

InboxMessage defines model for InboxMessage.

type InboxMessageCreate 

type InboxMessageCreate struct {
	BroadcastID *openapi_types.UUID `json:"broadcast_id,omitempty"`
	CampaignID  *openapi_types.UUID `json:"campaign_id,omitempty"`
	Channel     Channel             `json:"channel"`

	// Content Channel-specific payload content.
	Content   *json.RawMessage `json:"content,omitempty"`
	Data      *map[string]any  `json:"data,omitempty"`
	ExpiresAt *time.Time       `json:"expires_at,omitempty"`

	// Identifier An external identifier with source and optional metadata
	Identifier  ExternalID `json:"identifier"`
	Priority    *int16     `json:"priority,omitempty"`
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// SenderIdentityID Required for email and sms messages. Push uses project push provider settings.
	SenderIdentityID *openapi_types.UUID `json:"sender_identity_id,omitempty"`
	Source           *string             `json:"source,omitempty"`
	Tags             *[]string           `json:"tags,omitempty"`

	// Target One or more external identifiers to identify the user
	Target UserIdentifier `json:"target"`
}

InboxMessageCreate defines model for InboxMessageCreate.

type InboxMessageList 

type InboxMessageList struct {
	Limit   int            `json:"limit"`
	Offset  int            `json:"offset"`
	Results []InboxMessage `json:"results"`
	Total   int            `json:"total"`
}

InboxMessageList defines model for InboxMessageList.

type Limit 

type Limit = PaginationLimit

Limit defines model for Limit.

type Offset 

type Offset = PaginationOffset

Offset defines model for Offset.

type Organization 

type Organization struct {
	CreatedAt time.Time          `json:"created_at"`
	Data      map[string]any     `json:"data"`
	ID        openapi_types.UUID `json:"id"`

	// Identifier External identifiers associated with this organization
	Identifier []ExternalIDResponse `json:"identifier"`
	Name       *string              `json:"name,omitempty"`
	ProjectID  openapi_types.UUID   `json:"project_id"`
	UpdatedAt  time.Time            `json:"updated_at"`
	Version    int32                `json:"version"`
}

Organization defines model for Organization.

type OrganizationEvent 

type OrganizationEvent struct {
	// Data Event-specific data
	Data *map[string]any `json:"data,omitempty"`

	// Identifier One or more external identifiers to identify the organization
	Identifier *OrganizationIdentifier `json:"identifier,omitempty"`

	// Match JSONB containment filter to match organizations by their data attributes. Mutually exclusive with identifier. When set, the event is delivered to every organization whose data column contains the given key/value pairs.
	Match *map[string]any `json:"match,omitempty"`

	// Name The name of the event
	Name string `json:"name"`
}

OrganizationEvent defines model for OrganizationEvent.

type OrganizationIdentifier 

type OrganizationIdentifier = []ExternalID

OrganizationIdentifier One or more external identifiers to identify the organization

type OrganizationInboxMessageCreate 

type OrganizationInboxMessageCreate struct {
	BroadcastID *openapi_types.UUID `json:"broadcast_id,omitempty"`
	CampaignID  *openapi_types.UUID `json:"campaign_id,omitempty"`
	Channel     Channel             `json:"channel"`

	// Content Channel-specific payload content.
	Content   *json.RawMessage `json:"content,omitempty"`
	Data      *map[string]any  `json:"data,omitempty"`
	ExpiresAt *time.Time       `json:"expires_at,omitempty"`

	// Identifier An external identifier with source and optional metadata
	Identifier  ExternalID `json:"identifier"`
	Priority    *int16     `json:"priority,omitempty"`
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// SenderIdentityID Required for email and sms messages. Push uses project push provider settings.
	SenderIdentityID *openapi_types.UUID `json:"sender_identity_id,omitempty"`
	Source           *string             `json:"source,omitempty"`
	Tags             *[]string           `json:"tags,omitempty"`

	// Target One or more external identifiers to identify the organization
	Target OrganizationIdentifier `json:"target"`
}

OrganizationInboxMessageCreate defines model for OrganizationInboxMessageCreate.

type OrganizationInboxMessageEvents 

type OrganizationInboxMessageEvents = []OrganizationInboxMessageRef

OrganizationInboxMessageEvents defines model for OrganizationInboxMessageEvents.

type OrganizationInboxMessageRef 

type OrganizationInboxMessageRef struct {
	MessageID openapi_types.UUID `json:"message_id"`

	// Target One or more external identifiers to identify the organization
	Target OrganizationIdentifier `json:"target"`
}

OrganizationInboxMessageRef defines model for OrganizationInboxMessageRef.

type OrganizationRequest 

type OrganizationRequest struct {
	Data *map[string]any `json:"data,omitempty"`

	// Identifier One or more external identifiers to identify the organization
	Identifier OrganizationIdentifier `json:"identifier"`
	Name       *string                `json:"name,omitempty"`
}

OrganizationRequest defines model for OrganizationRequest.

type OrganizationUserRequest 

type OrganizationUserRequest struct {
	// Data Organization-specific data for this user
	Data         *map[string]any `json:"data,omitempty"`
	Organization struct {
		// Identifier One or more external identifiers to identify the organization
		Identifier OrganizationIdentifier `json:"identifier"`
	} `json:"organization"`
	User struct {
		// Identifier One or more external identifiers to identify the user
		Identifier UserIdentifier `json:"identifier"`
	} `json:"user"`
}

OrganizationUserRequest defines model for OrganizationUserRequest.

type PaginationLimit 

type PaginationLimit int

PaginationLimit and PaginationOffset back the `x-go-type` references in the vendored spec's pagination query parameters (the Limit/Offset components).

The platform defines these in a hand-written companion file alongside its own generated code; the SDK mirrors that pattern here so the generated package is self-contained. They are only referenced by the inbox/list parameters, which the SDK facade does not currently expose. This file is hand-written and is not overwritten by `go generate`.

type PaginationOffset 

type PaginationOffset int

PaginationLimit and PaginationOffset back the `x-go-type` references in the vendored spec's pagination query parameters (the Limit/Offset components).

The platform defines these in a hand-written companion file alongside its own generated code; the SDK mirrors that pattern here so the generated package is self-contained. They are only referenced by the inbox/list parameters, which the SDK facade does not currently expose. This file is hand-written and is not overwritten by `go generate`.

type PostEventsRequest 

type PostEventsRequest = []Event

PostEventsRequest defines model for PostEventsRequest.

type PostOrganizationEventsClientJSONRequestBody 

type PostOrganizationEventsClientJSONRequestBody = PostOrganizationEventsRequest

PostOrganizationEventsClientJSONRequestBody defines body for PostOrganizationEventsClient for application/json ContentType.

type PostOrganizationEventsRequest 

type PostOrganizationEventsRequest = []OrganizationEvent

PostOrganizationEventsRequest defines model for PostOrganizationEventsRequest.

type PostOrganizationInboxArchivedJSONRequestBody 

type PostOrganizationInboxArchivedJSONRequestBody = OrganizationInboxMessageEvents

PostOrganizationInboxArchivedJSONRequestBody defines body for PostOrganizationInboxArchived for application/json ContentType.

type PostOrganizationInboxMessagesJSONRequestBody 

type PostOrganizationInboxMessagesJSONRequestBody = PostOrganizationInboxMessagesRequest

PostOrganizationInboxMessagesJSONRequestBody defines body for PostOrganizationInboxMessages for application/json ContentType.

type PostOrganizationInboxMessagesRequest 

type PostOrganizationInboxMessagesRequest = []OrganizationInboxMessageCreate

PostOrganizationInboxMessagesRequest defines model for PostOrganizationInboxMessagesRequest.

type PostOrganizationInboxReadJSONRequestBody 

type PostOrganizationInboxReadJSONRequestBody = OrganizationInboxMessageEvents

PostOrganizationInboxReadJSONRequestBody defines body for PostOrganizationInboxRead for application/json ContentType.

type PostUserEventsJSONRequestBody 

type PostUserEventsJSONRequestBody = PostEventsRequest

PostUserEventsJSONRequestBody defines body for PostUserEvents for application/json ContentType.

type PostUserInboxArchivedJSONRequestBody 

type PostUserInboxArchivedJSONRequestBody = UserInboxMessageEvents

PostUserInboxArchivedJSONRequestBody defines body for PostUserInboxArchived for application/json ContentType.

type PostUserInboxMessagesJSONRequestBody 

type PostUserInboxMessagesJSONRequestBody = PostUserInboxMessagesRequest

PostUserInboxMessagesJSONRequestBody defines body for PostUserInboxMessages for application/json ContentType.

type PostUserInboxMessagesRequest 

type PostUserInboxMessagesRequest = []InboxMessageCreate

PostUserInboxMessagesRequest defines model for PostUserInboxMessagesRequest.

type PostUserInboxReadJSONRequestBody 

type PostUserInboxReadJSONRequestBody = UserInboxMessageEvents

PostUserInboxReadJSONRequestBody defines body for PostUserInboxRead for application/json ContentType.

type Problem 

type Problem struct {
	// Detail A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
	Detail string `json:"detail"`

	// Title A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
	Title string `json:"title"`
}

Problem defines model for Problem.

type ProjectID 

type ProjectID = openapi_types.UUID

ProjectID defines model for ProjectID.

type RegisterDeviceJSONRequestBody 

type RegisterDeviceJSONRequestBody = DeviceRegistration

RegisterDeviceJSONRequestBody defines body for RegisterDevice for application/json ContentType.

type RemoveOrganizationUserClientJSONRequestBody 

type RemoveOrganizationUserClientJSONRequestBody = RemoveOrganizationUserRequest

RemoveOrganizationUserClientJSONRequestBody defines body for RemoveOrganizationUserClient for application/json ContentType.

type RemoveOrganizationUserRequest 

type RemoveOrganizationUserRequest struct {
	Organization struct {
		// Identifier One or more external identifiers to identify the organization
		Identifier OrganizationIdentifier `json:"identifier"`
	} `json:"organization"`
	User struct {
		// Identifier One or more external identifiers to identify the user
		Identifier UserIdentifier `json:"identifier"`
	} `json:"user"`
}

RemoveOrganizationUserRequest defines model for RemoveOrganizationUserRequest.

type ScheduledAccepted 

type ScheduledAccepted struct {
	// Data Scheduled resource data
	Data *map[string]any `json:"data,omitempty"`

	// ID The unique identifier for the scheduled instance
	ID openapi_types.UUID `json:"id"`

	// Name The name of the scheduled resource
	Name string `json:"name"`

	// ScheduledAt The time at which the scheduled resource is set to trigger
	ScheduledAt time.Time `json:"scheduled_at"`
}

ScheduledAccepted defines model for ScheduledAccepted.

type SessionToken 

type SessionToken struct {
	ExpiresAt time.Time `json:"expires_at"`

	// Token The signed session token (a bearer token for the Client API).
	Token string `json:"token"`
}

SessionToken defines model for SessionToken.

type UpdatePreferencesFormdataBody 

type UpdatePreferencesFormdataBody struct {
	// SubscriptionIds Array of subscription IDs to keep subscribed
	SubscriptionIds *[]openapi_types.UUID `form:"subscriptionIds,omitempty" json:"subscriptionIds,omitempty"`
}

UpdatePreferencesFormdataBody defines parameters for UpdatePreferences.

type UpdatePreferencesFormdataRequestBody 

type UpdatePreferencesFormdataRequestBody UpdatePreferencesFormdataBody

UpdatePreferencesFormdataRequestBody defines body for UpdatePreferences for application/x-www-form-urlencoded ContentType.

type UpsertOrganizationClientJSONRequestBody 

type UpsertOrganizationClientJSONRequestBody = OrganizationRequest

UpsertOrganizationClientJSONRequestBody defines body for UpsertOrganizationClient for application/json ContentType.

type UpsertOrganizationScheduledClientJSONRequestBody 

type UpsertOrganizationScheduledClientJSONRequestBody = UpsertOrganizationScheduledRequest

UpsertOrganizationScheduledClientJSONRequestBody defines body for UpsertOrganizationScheduledClient for application/json ContentType.

type UpsertOrganizationScheduledRequest 

type UpsertOrganizationScheduledRequest struct {
	// Data Scheduled resource data
	Data *map[string]any `json:"data,omitempty"`

	// ID The id of the schedule assignment. Omit to create a new assignment (multiple assignments may share the same name per organization); supply an existing id to update that assignment in place. The id is returned in the response.
	ID *openapi_types.UUID `json:"id,omitempty"`

	// Identifier One or more external identifiers to identify the organization
	Identifier OrganizationIdentifier `json:"identifier"`

	// Interval Interval for recurring schedules. When set, the schedule type is automatically set to recurring.
	Interval *string `json:"interval,omitempty"`

	// Name The name of the scheduled resource
	Name string `json:"name"`

	// ScheduledAt The time at which the scheduled resource is set to trigger. Required for single schedules.
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// StartAt Start time for recurring schedules. If omitted for recurring schedules, defaults to now.
	StartAt *time.Time `json:"start_at,omitempty"`
}

UpsertOrganizationScheduledRequest defines model for UpsertOrganizationScheduledRequest.

type UpsertUserClientJSONRequestBody 

type UpsertUserClientJSONRequestBody = IdentifyRequest

UpsertUserClientJSONRequestBody defines body for UpsertUserClient for application/json ContentType.

type UpsertUserScheduledClientJSONRequestBody 

type UpsertUserScheduledClientJSONRequestBody = UpsertUserScheduledRequest

UpsertUserScheduledClientJSONRequestBody defines body for UpsertUserScheduledClient for application/json ContentType.

type UpsertUserScheduledRequest 

type UpsertUserScheduledRequest struct {
	// Data Scheduled resource data
	Data *map[string]any `json:"data,omitempty"`

	// ID The id of the schedule assignment. Omit to create a new assignment (multiple assignments may share the same name per user); supply an existing id to update that assignment in place. The id is returned in the response.
	ID *openapi_types.UUID `json:"id,omitempty"`

	// Identifier One or more external identifiers to identify the user
	Identifier *UserIdentifier `json:"identifier,omitempty"`

	// Interval Interval for recurring schedules. When set, the schedule type is automatically set to recurring.
	Interval *string `json:"interval,omitempty"`

	// Name The name of the scheduled resource
	Name string `json:"name"`

	// ScheduledAt The time at which the scheduled resource is set to trigger. Required for single schedules.
	ScheduledAt *time.Time `json:"scheduled_at,omitempty"`

	// StartAt Start time for recurring schedules. If omitted for recurring schedules, defaults to now.
	StartAt *time.Time `json:"start_at,omitempty"`
}

UpsertUserScheduledRequest defines model for UpsertUserScheduledRequest.

type User 

type User struct {
	CreatedAt     time.Time          `json:"created_at"`
	Data          map[string]any     `json:"data"`
	Email         *string            `json:"email,omitempty"`
	HasPushDevice bool               `json:"has_push_device"`
	ID            openapi_types.UUID `json:"id"`

	// Identifier External identifiers associated with this user
	Identifier []ExternalIDResponse `json:"identifier"`
	Locale     *string              `json:"locale,omitempty"`

	// Phone E.164 formatted phone number
	Phone     *string            `json:"phone,omitempty"`
	ProjectID openapi_types.UUID `json:"project_id"`
	Timezone  *string            `json:"timezone,omitempty"`
	UpdatedAt time.Time          `json:"updated_at"`
	Version   int32              `json:"version"`
}

User defines model for User.

type UserIdentifier 

type UserIdentifier = []ExternalID

UserIdentifier One or more external identifiers to identify the user

type UserInboxMessageEvents 

type UserInboxMessageEvents = []UserInboxMessageRef

UserInboxMessageEvents defines model for UserInboxMessageEvents.

type UserInboxMessageRef 

type UserInboxMessageRef struct {
	MessageID openapi_types.UUID `json:"message_id"`

	// Target One or more external identifiers to identify the user
	Target UserIdentifier `json:"target"`
}

UserInboxMessageRef defines model for UserInboxMessageRef.

type VapidPublicKey 

type VapidPublicKey struct {
	// PublicKey The VAPID public key
	PublicKey string `json:"public_key"`
}

VapidPublicKey defines model for VapidPublicKey.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.