models

type ClientDetails struct {

	// url to a client website
	// Example: https://example.com
	ClientURI string `json:"client_uri,omitempty" yaml:"client_uri,omitempty"`

	// client id
	// Example: default
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// url to a page where client logo is served
	// Example: https://example.com/logo.png
	LogoURI string `json:"logo_uri,omitempty" yaml:"logo_uri,omitempty"`

	// client name
	// Example: My app
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
}

type ClientWithAccess struct {

	// client
	Client *ClientDetails `json:"client,omitempty" yaml:"client,omitempty"`

	// Scopes granted to client
	GrantedScopes []*GrantedScope `json:"granted_scopes" yaml:"granted_scopes"`
}

type Consent struct {

	// flag determining if can user withdrawn consent
	// Example: false
	CanBeWithdrawn bool `json:"can_be_withdrawn,omitempty" yaml:"can_be_withdrawn,omitempty"`

	// consent description
	// Example: End User License Agreement
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// consent unique identifier
	// Example: 1
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// internal services
	InternalServices []*ConsentService `json:"internal_services" yaml:"internal_services"`

	// consent name
	// Example: EULA
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// PII Categories
	PiiCategories []*PIICategory `json:"pii_categories" yaml:"pii_categories"`

	// tenant id
	// Example: default
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// third party services
	ThirdPartyServices []*ConsentService `json:"third_party_services" yaml:"third_party_services"`

	// strategy for upading existing grants, one of: explicitAll, implicitAll, keepCurrent
	// Example: explicitAll
	UpdateExistingGrants string `json:"update_existing_grants,omitempty" yaml:"update_existing_grants,omitempty"`

	// marks the time from which the consent is in use. Can't be set to a future time
	// Example: 2019-12-11T13:44:28.772101Z
	// Format: date-time
	ValidFrom strfmt.DateTime `json:"valid_from,omitempty" yaml:"valid_from,omitempty"`

	// consent version. When a consent is updated, version is incremented.
	// Example: 1
	Version int64 `json:"version,omitempty" yaml:"version,omitempty"`
}

type ConsentGrant struct {

	// consent grant id
	// Example: 27fa83a8-d0a6-48da-8529-42105bfa0ede
	ConsentGrantActID string `json:"consent_grant_act_id,omitempty" yaml:"consent_grant_act_id,omitempty"`

	// consent id
	// Example: 1
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// given at timestamp
	// Format: date-time
	GivenAt strfmt.DateTime `json:"given_at,omitempty" yaml:"given_at,omitempty"`

	// grant type, one of: implicit, explicit
	// Example: implicit
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// subject
	// Example: peter
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// tenant id
	// Example: default
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// version
	// Example: 1
	Version int64 `json:"version,omitempty" yaml:"version,omitempty"`
}

type ConsentGrantContext struct {

	// json object - device print of the End User's device
	Device map[string]interface{} `json:"device,omitempty" yaml:"device,omitempty"`

	// string in the form of a valid IP v 4 address, represents the current IP of the End User
	// Example: 52.14.142.76
	IP string `json:"ip,omitempty" yaml:"ip,omitempty"`

	// 2 element array of floats - current geolocation of the end-user, the format is [lat, long]
	// Example: [25.2084,55.2719]
	Location []float64 `json:"location" yaml:"location"`
}

type ConsentGrantPatch struct {

	// consent id
	// Example: 1
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// one of: implicit, explicit (explicit is the default value)
	// Example: implicit
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// boolean flag marking if the user granted or revoked the consent
	// Example: false
	Granted bool `json:"granted,omitempty" yaml:"granted,omitempty"`
}

type ConsentGrantPatchRequest struct {

	// time when the grant occurred
	// Example: 1257894000000000000
	CollectionTimestamp int64 `json:"collection_timestamp,omitempty" yaml:"collection_timestamp,omitempty"`

	// an array of consent objects, consisting of consentId and granted - boolean flag marking if the user granted or revoked the consent
	Consents []*ConsentGrantPatch `json:"consents" yaml:"consents"`

	// context
	Context *ConsentGrantContext `json:"context,omitempty" yaml:"context,omitempty"`

	// language in which the consent was obtained [ISO 639]
	// Example: en
	Language string `json:"language,omitempty" yaml:"language,omitempty"`

	// optional string with action_id - can be set if the consent grant/withdraw request was caused when an app asked the user for consent required for a specific action
	// Example: 1
	TriggeredByAction string `json:"triggered_by_action,omitempty" yaml:"triggered_by_action,omitempty"`
}

type ConsentGrantPatchResponse struct {

	// id of the consent grant action
	ConsentGrantActID string `json:"ConsentGrantActID,omitempty" yaml:"ConsentGrantActID,omitempty"`

	// time when the grant occurred
	// Example: 1257894000000000000
	CollectionTimestamp int64 `json:"collection_timestamp,omitempty" yaml:"collection_timestamp,omitempty"`

	// an array of consent objects, consisting of consentId and granted - boolean flag marking if the user granted or revoked the consent
	Consents []*ConsentGrantPatch `json:"consents" yaml:"consents"`

	// context
	Context *ConsentGrantContext `json:"context,omitempty" yaml:"context,omitempty"`

	// language in which the consent was obtained [ISO 639]
	// Example: en
	Language string `json:"language,omitempty" yaml:"language,omitempty"`

	// optional string with action_id - can be set if the consent grant/withdraw request was caused when an app asked the user for consent required for a specific action
	// Example: 1
	TriggeredByAction string `json:"triggered_by_action,omitempty" yaml:"triggered_by_action,omitempty"`
}

type ConsentGrantRequest struct {

	// time when the grant occurred
	// Example: 1257894000000000000
	CollectionTimestamp int64 `json:"collection_timestamp,omitempty" yaml:"collection_timestamp,omitempty"`

	// consent id
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// context
	Context *ConsentGrantContext `json:"context,omitempty" yaml:"context,omitempty"`

	// grant type
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// language in which the consent was obtained [ISO 639]
	// Example: en
	Language string `json:"language,omitempty" yaml:"language,omitempty"`

	// optional string with action_id - can be set if the consent grant/withdraw request was caused when an app asked the user for consent required for a specific action
	// Example: 1
	TriggeredByAction string `json:"triggered_by_action,omitempty" yaml:"triggered_by_action,omitempty"`
}

type ConsentGrantedEvent struct {

	// time when the grant occurred
	// Example: 1257894000000000000
	CollectionTimestamp int64 `json:"collection_timestamp,omitempty" yaml:"collection_timestamp,omitempty"`

	// consent
	Consent *Consent `json:"consent,omitempty" yaml:"consent,omitempty"`

	// consent grant id
	// Example: 27fa83a8-d0a6-48da-8529-42105bfa0ede
	ConsentGrantActID string `json:"consent_grant_act_id,omitempty" yaml:"consent_grant_act_id,omitempty"`

	// consent id
	// Example: 1
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// context
	Context *ConsentGrantContext `json:"context,omitempty" yaml:"context,omitempty"`

	// given at timestamp
	// Format: date-time
	GivenAt strfmt.DateTime `json:"given_at,omitempty" yaml:"given_at,omitempty"`

	// grant type, one of: implicit, explicit
	// Example: implicit
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// language in which the consent was obtained [ISO 639]
	// Example: en
	Language string `json:"language,omitempty" yaml:"language,omitempty"`

	// subject
	// Example: peter
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// tenant id
	// Example: default
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// optional string with action_id - can be set if the consent grant/withdraw request was caused when an app asked the user for consent required for a specific action
	// Example: 1
	TriggeredByAction string `json:"triggered_by_action,omitempty" yaml:"triggered_by_action,omitempty"`

	// version
	// Example: 1
	Version int64 `json:"version,omitempty" yaml:"version,omitempty"`
}

type ConsentRevokedEvent struct {

	// time when the grant occurred
	// Example: 1257894000000000000
	CollectionTimestamp int64 `json:"collection_timestamp,omitempty" yaml:"collection_timestamp,omitempty"`

	// consent
	Consent *Consent `json:"consent,omitempty" yaml:"consent,omitempty"`

	// consent grant id
	// Example: 27fa83a8-d0a6-48da-8529-42105bfa0ede
	ConsentGrantActID string `json:"consent_grant_act_id,omitempty" yaml:"consent_grant_act_id,omitempty"`

	// consent id
	// Example: 1
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// context
	Context *ConsentGrantContext `json:"context,omitempty" yaml:"context,omitempty"`

	// given at timestamp
	// Format: date-time
	GivenAt strfmt.DateTime `json:"given_at,omitempty" yaml:"given_at,omitempty"`

	// grant type, one of: implicit, explicit
	// Example: implicit
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// language in which the consent was obtained [ISO 639]
	// Example: en
	Language string `json:"language,omitempty" yaml:"language,omitempty"`

	// subject
	// Example: peter
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// tenant id
	// Example: default
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// optional string with action_id - can be set if the consent grant/withdraw request was caused when an app asked the user for consent required for a specific action
	// Example: 1
	TriggeredByAction string `json:"triggered_by_action,omitempty" yaml:"triggered_by_action,omitempty"`

	// version
	// Example: 1
	Version int64 `json:"version,omitempty" yaml:"version,omitempty"`
}

type ConsentService struct {

	// name
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// purpose
	Purposes []*Purpose `json:"purposes" yaml:"purposes"`
}

type ConsentWithGrant struct {

	// flag determining if can user withdrawn consent
	// Example: false
	CanBeWithdrawn bool `json:"can_be_withdrawn,omitempty" yaml:"can_be_withdrawn,omitempty"`

	// consent grant id
	// Example: 27fa83a8-d0a6-48da-8529-42105bfa0ede
	ConsentGrantID string `json:"consent_grant_id,omitempty" yaml:"consent_grant_id,omitempty"`

	// consent description
	// Example: End User License Agreement
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// given at timestamp
	// Format: date-time
	GivenAt strfmt.DateTime `json:"given_at,omitempty" yaml:"given_at,omitempty"`

	// grant type
	// Example: implicit
	GrantType string `json:"grant_type,omitempty" yaml:"grant_type,omitempty"`

	// grant version
	// Example: 1
	GrantVersion int64 `json:"grant_version,omitempty" yaml:"grant_version,omitempty"`

	// is consent granted
	// Example: false
	Granted bool `json:"granted,omitempty" yaml:"granted,omitempty"`

	// consent unique identifier
	// Example: 1
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// internal services
	InternalServices []*ConsentService `json:"internal_services" yaml:"internal_services"`

	// consent name
	// Example: EULA
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// PII Categories
	PiiCategories []*PIICategory `json:"pii_categories" yaml:"pii_categories"`

	// subject
	// Example: peter
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// tenant id
	// Example: default
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// third party services
	ThirdPartyServices []*ConsentService `json:"third_party_services" yaml:"third_party_services"`

	// strategy for upading existing grants, one of: explicitAll, implicitAll, keepCurrent
	// Example: explicitAll
	UpdateExistingGrants string `json:"update_existing_grants,omitempty" yaml:"update_existing_grants,omitempty"`

	// marks the time from which the consent is in use. Can't be set to a future time
	// Example: 2019-12-11T13:44:28.772101Z
	// Format: date-time
	ValidFrom strfmt.DateTime `json:"valid_from,omitempty" yaml:"valid_from,omitempty"`

	// consent version. When a consent is updated, version is incremented.
	// Example: 1
	Version int64 `json:"version,omitempty" yaml:"version,omitempty"`
}

type ConsentsWithGrants struct {

	// list of consents
	Consents []*ConsentWithGrant `json:"consents" yaml:"consents"`
}

type Error struct {

	// details
	Details interface{} `json:"details,omitempty" yaml:"details,omitempty"`

	// error
	Error string `json:"error,omitempty" yaml:"error,omitempty"`

	// status code
	StatusCode int64 `json:"status_code,omitempty" yaml:"status_code,omitempty"`
}

type GrantedScope struct {

	// granted scope name
	GrantedScopeName string `json:"granted_scope_name,omitempty" yaml:"granted_scope_name,omitempty"`

	// is dynamic
	IsDynamic bool `json:"is_dynamic,omitempty" yaml:"is_dynamic,omitempty"`

	// scope name
	ScopeName string `json:"scope_name,omitempty" yaml:"scope_name,omitempty"`
}

type ListClientsWithAccess struct {

	// clients
	Clients []*ClientWithAccess `json:"clients" yaml:"clients"`

	// scopes
	Scopes []*ScopeWithServicePublicResponse `json:"scopes" yaml:"scopes"`
}

type ListUserSessions struct {

	// sessions
	Sessions []*UserSession `json:"sessions" yaml:"sessions"`
}

type PIICategory struct {

	// name
	// Example: HIPAA
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
}

type PrivacyLedgerEvent struct {

	// date
	// Format: date-time
	Date strfmt.DateTime `json:"date,omitempty" yaml:"date,omitempty"`

	// id
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// payload
	Payload *PrivacyLedgerPayload `json:"payload,omitempty" yaml:"payload,omitempty"`

	// payload signature
	PayloadSignature string `json:"payload_signature,omitempty" yaml:"payload_signature,omitempty"`

	// subject
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// tenant id
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
}

type PrivacyLedgerEventType string

type PrivacyLedgerEvents struct {

	// events
	Events []*PrivacyLedgerEvent `json:"events" yaml:"events"`
}

type PrivacyLedgerPayload struct {

	// consent granted
	ConsentGranted *ConsentGrantedEvent `json:"consent_granted,omitempty" yaml:"consent_granted,omitempty"`

	// consent revoked
	ConsentRevoked *ConsentRevokedEvent `json:"consent_revoked,omitempty" yaml:"consent_revoked,omitempty"`

	// event type
	EventType PrivacyLedgerEventType `json:"event_type,omitempty" yaml:"event_type,omitempty"`
}

type PublicEnvironment struct {

	// If self-service is enabled
	SelfService bool `json:"self_service,omitempty" yaml:"self_service,omitempty"`
}

type Purpose struct {

	// name
	// Example: Core Function
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// is the purpose primary. If there are multiple purposes defined, one of them must be marked as primary.
	// Example: true
	Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
}

type ScopeWithServicePublicResponse struct {

	// scope description
	// Example: This scope value requests offline access using refresh token
	ScopeDescription string `json:"scope_description,omitempty" yaml:"scope_description,omitempty"`

	// scope display name
	// Example: Offline access
	ScopeDisplayName string `json:"scope_display_name,omitempty" yaml:"scope_display_name,omitempty"`

	// scope id
	// Example: 1
	ScopeID string `json:"scope_id,omitempty" yaml:"scope_id,omitempty"`

	// scope name
	// Example: offline_access
	ScopeName string `json:"scope_name,omitempty" yaml:"scope_name,omitempty"`

	// service description
	// Example: service description
	ServiceDescription string `json:"service_description,omitempty" yaml:"service_description,omitempty"`

	// service id
	// Example: 1
	ServiceID string `json:"service_id,omitempty" yaml:"service_id,omitempty"`

	// service name
	// Example: service
	ServiceName string `json:"service_name,omitempty" yaml:"service_name,omitempty"`

	// is scope assigned to a service
	// Example: false
	WithService bool `json:"with_service,omitempty" yaml:"with_service,omitempty"`
}

type TransientOTPRequest struct {

	// address
	// Example: 1235555609
	// Required: true
	Address string `json:"address" yaml:"address"`

	// mechanism
	// Example: email
	// Required: true
	// Enum: [sms email]
	Mechanism string `json:"mechanism" yaml:"mechanism"`

	// one-time password
	// Example: 111111
	Otp string `json:"otp,omitempty" yaml:"otp,omitempty"`

	// Optional XSRF state
	// Example: c44sqtco4g2legl15m2g
	State string `json:"state,omitempty" yaml:"state,omitempty"`
}

type TransientOTPResponse struct {

	// address
	// Example: 8675409
	// Required: true
	Address string `json:"address" yaml:"address"`

	// created at
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`

	// expires in
	// Format: duration
	ExpiresIn strfmt.Duration `json:"expires_in,omitempty" yaml:"expires_in,omitempty"`

	// id
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// mechanism
	// Example: email
	// Required: true
	// Enum: [sms email]
	Mechanism string `json:"mechanism" yaml:"mechanism"`

	// tenant id
	// Example: default
	// Required: true
	TenantID string `json:"tenant_id" yaml:"tenant_id"`

	// updated at
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`

	// verified
	Verified bool `json:"verified,omitempty" yaml:"verified,omitempty"`
}

type UserSession struct {

	// Time when the session was last used
	// Format: date-time
	ActiveTime strfmt.DateTime `json:"active_time,omitempty" yaml:"active_time,omitempty"`

	// time when user authenticated
	// Format: date-time
	AuthTime strfmt.DateTime `json:"auth_time,omitempty" yaml:"auth_time,omitempty"`

	// Session id
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// IP address of the user who created the session
	IPAddress string `json:"ip_address,omitempty" yaml:"ip_address,omitempty"`

	// Time when the session was issued
	// Format: date-time
	IssueTime strfmt.DateTime `json:"issue_time,omitempty" yaml:"issue_time,omitempty"`

	// Session type
	Type string `json:"type,omitempty" yaml:"type,omitempty"`

	// User agent of the user who created the session
	UserAgent string `json:"user_agent,omitempty" yaml:"user_agent,omitempty"`
}