registry

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetDataHolderBrandsRequest 

func NewGetDataHolderBrandsRequest(server string, industry GetDataHolderBrandsParamsIndustry, params *GetDataHolderBrandsParams) (*http.Request, error)

NewGetDataHolderBrandsRequest generates requests for GetDataHolderBrands

func NewGetDataHolderBrandsSummaryRequest 

func NewGetDataHolderBrandsSummaryRequest(server string, industry GetDataHolderBrandsSummaryParamsIndustry, params *GetDataHolderBrandsSummaryParams) (*http.Request, error)

NewGetDataHolderBrandsSummaryRequest generates requests for GetDataHolderBrandsSummary

func NewGetDataHolderStatusesRequest 

func NewGetDataHolderStatusesRequest(server string, industry GetDataHolderStatusesParamsIndustry, params *GetDataHolderStatusesParams) (*http.Request, error)

NewGetDataHolderStatusesRequest generates requests for GetDataHolderStatuses

func NewGetDataRecipientsRequest 

func NewGetDataRecipientsRequest(server string, industry GetDataRecipientsParamsIndustry, params *GetDataRecipientsParams) (*http.Request, error)

NewGetDataRecipientsRequest generates requests for GetDataRecipients

func NewGetDataRecipientsStatusesRequest 

func NewGetDataRecipientsStatusesRequest(server string, industry GetDataRecipientsStatusesParamsIndustry, params *GetDataRecipientsStatusesParams) (*http.Request, error)

NewGetDataRecipientsStatusesRequest generates requests for GetDataRecipientsStatuses

func NewGetJWKSRequest 

func NewGetJWKSRequest(server string) (*http.Request, error)

NewGetJWKSRequest generates requests for GetJWKS

func NewGetOpenIdProviderConfigRequest 

func NewGetOpenIdProviderConfigRequest(server string) (*http.Request, error)

NewGetOpenIdProviderConfigRequest generates requests for GetOpenIdProviderConfig

func NewGetSoftwareProductsStatusesRequest 

func NewGetSoftwareProductsStatusesRequest(server string, industry GetSoftwareProductsStatusesParamsIndustry, params *GetSoftwareProductsStatusesParams) (*http.Request, error)

NewGetSoftwareProductsStatusesRequest generates requests for GetSoftwareProductsStatuses

func NewGetSoftwareStatementAssertionRequest 

func NewGetSoftwareStatementAssertionRequest(server string, industry GetSoftwareStatementAssertionParamsIndustry, dataRecipientBrandId string, softwareProductId string, params *GetSoftwareStatementAssertionParams) (*http.Request, error)

NewGetSoftwareStatementAssertionRequest generates requests for GetSoftwareStatementAssertion

Types

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetDataHolderBrands 

func (c *Client) GetDataHolderBrands(ctx context.Context, industry GetDataHolderBrandsParamsIndustry, params *GetDataHolderBrandsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDataHolderBrandsSummary 

func (c *Client) GetDataHolderBrandsSummary(ctx context.Context, industry GetDataHolderBrandsSummaryParamsIndustry, params *GetDataHolderBrandsSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDataHolderStatuses 

func (c *Client) GetDataHolderStatuses(ctx context.Context, industry GetDataHolderStatusesParamsIndustry, params *GetDataHolderStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDataRecipients 

func (c *Client) GetDataRecipients(ctx context.Context, industry GetDataRecipientsParamsIndustry, params *GetDataRecipientsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDataRecipientsStatuses 

func (c *Client) GetDataRecipientsStatuses(ctx context.Context, industry GetDataRecipientsStatusesParamsIndustry, params *GetDataRecipientsStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetJWKS 

func (c *Client) GetJWKS(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOpenIdProviderConfig 

func (c *Client) GetOpenIdProviderConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSoftwareProductsStatuses 

func (c *Client) GetSoftwareProductsStatuses(ctx context.Context, industry GetSoftwareProductsStatusesParamsIndustry, params *GetSoftwareProductsStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSoftwareStatementAssertion 

func (c *Client) GetSoftwareStatementAssertion(ctx context.Context, industry GetSoftwareStatementAssertionParamsIndustry, dataRecipientBrandId string, softwareProductId string, params *GetSoftwareStatementAssertionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetOpenIdProviderConfig request
	GetOpenIdProviderConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataHolderBrands request
	GetDataHolderBrands(ctx context.Context, industry GetDataHolderBrandsParamsIndustry, params *GetDataHolderBrandsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataHolderBrandsSummary request
	GetDataHolderBrandsSummary(ctx context.Context, industry GetDataHolderBrandsSummaryParamsIndustry, params *GetDataHolderBrandsSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataHolderStatuses request
	GetDataHolderStatuses(ctx context.Context, industry GetDataHolderStatusesParamsIndustry, params *GetDataHolderStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataRecipients request
	GetDataRecipients(ctx context.Context, industry GetDataRecipientsParamsIndustry, params *GetDataRecipientsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSoftwareProductsStatuses request
	GetSoftwareProductsStatuses(ctx context.Context, industry GetSoftwareProductsStatusesParamsIndustry, params *GetSoftwareProductsStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSoftwareStatementAssertion request
	GetSoftwareStatementAssertion(ctx context.Context, industry GetSoftwareStatementAssertionParamsIndustry, dataRecipientBrandId string, softwareProductId string, params *GetSoftwareStatementAssertionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataRecipientsStatuses request
	GetDataRecipientsStatuses(ctx context.Context, industry GetDataRecipientsStatusesParamsIndustry, params *GetDataRecipientsStatusesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJWKS request
	GetJWKS(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetDataHolderBrandsSummaryWithResponse 

func (c *ClientWithResponses) GetDataHolderBrandsSummaryWithResponse(ctx context.Context, industry GetDataHolderBrandsSummaryParamsIndustry, params *GetDataHolderBrandsSummaryParams, reqEditors ...RequestEditorFn) (*GetDataHolderBrandsSummaryResponse, error)

GetDataHolderBrandsSummaryWithResponse request returning *GetDataHolderBrandsSummaryResponse

func (*ClientWithResponses) GetDataHolderBrandsWithResponse 

func (c *ClientWithResponses) GetDataHolderBrandsWithResponse(ctx context.Context, industry GetDataHolderBrandsParamsIndustry, params *GetDataHolderBrandsParams, reqEditors ...RequestEditorFn) (*GetDataHolderBrandsResponse, error)

GetDataHolderBrandsWithResponse request returning *GetDataHolderBrandsResponse

func (*ClientWithResponses) GetDataHolderStatusesWithResponse 

func (c *ClientWithResponses) GetDataHolderStatusesWithResponse(ctx context.Context, industry GetDataHolderStatusesParamsIndustry, params *GetDataHolderStatusesParams, reqEditors ...RequestEditorFn) (*GetDataHolderStatusesResponse, error)

GetDataHolderStatusesWithResponse request returning *GetDataHolderStatusesResponse

func (*ClientWithResponses) GetDataRecipientsStatusesWithResponse 

func (c *ClientWithResponses) GetDataRecipientsStatusesWithResponse(ctx context.Context, industry GetDataRecipientsStatusesParamsIndustry, params *GetDataRecipientsStatusesParams, reqEditors ...RequestEditorFn) (*GetDataRecipientsStatusesResponse, error)

GetDataRecipientsStatusesWithResponse request returning *GetDataRecipientsStatusesResponse

func (*ClientWithResponses) GetDataRecipientsWithResponse 

func (c *ClientWithResponses) GetDataRecipientsWithResponse(ctx context.Context, industry GetDataRecipientsParamsIndustry, params *GetDataRecipientsParams, reqEditors ...RequestEditorFn) (*GetDataRecipientsResponse, error)

GetDataRecipientsWithResponse request returning *GetDataRecipientsResponse

func (*ClientWithResponses) GetJWKSWithResponse 

func (c *ClientWithResponses) GetJWKSWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJWKSResponse, error)

GetJWKSWithResponse request returning *GetJWKSResponse

func (*ClientWithResponses) GetOpenIdProviderConfigWithResponse 

func (c *ClientWithResponses) GetOpenIdProviderConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenIdProviderConfigResponse, error)

GetOpenIdProviderConfigWithResponse request returning *GetOpenIdProviderConfigResponse

func (*ClientWithResponses) GetSoftwareProductsStatusesWithResponse 

func (c *ClientWithResponses) GetSoftwareProductsStatusesWithResponse(ctx context.Context, industry GetSoftwareProductsStatusesParamsIndustry, params *GetSoftwareProductsStatusesParams, reqEditors ...RequestEditorFn) (*GetSoftwareProductsStatusesResponse, error)

GetSoftwareProductsStatusesWithResponse request returning *GetSoftwareProductsStatusesResponse

func (*ClientWithResponses) GetSoftwareStatementAssertionWithResponse 

func (c *ClientWithResponses) GetSoftwareStatementAssertionWithResponse(ctx context.Context, industry GetSoftwareStatementAssertionParamsIndustry, dataRecipientBrandId string, softwareProductId string, params *GetSoftwareStatementAssertionParams, reqEditors ...RequestEditorFn) (*GetSoftwareStatementAssertionResponse, error)

GetSoftwareStatementAssertionWithResponse request returning *GetSoftwareStatementAssertionResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetOpenIdProviderConfig request
	GetOpenIdProviderConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenIdProviderConfigResponse, error)

	// GetDataHolderBrands request
	GetDataHolderBrandsWithResponse(ctx context.Context, industry GetDataHolderBrandsParamsIndustry, params *GetDataHolderBrandsParams, reqEditors ...RequestEditorFn) (*GetDataHolderBrandsResponse, error)

	// GetDataHolderBrandsSummary request
	GetDataHolderBrandsSummaryWithResponse(ctx context.Context, industry GetDataHolderBrandsSummaryParamsIndustry, params *GetDataHolderBrandsSummaryParams, reqEditors ...RequestEditorFn) (*GetDataHolderBrandsSummaryResponse, error)

	// GetDataHolderStatuses request
	GetDataHolderStatusesWithResponse(ctx context.Context, industry GetDataHolderStatusesParamsIndustry, params *GetDataHolderStatusesParams, reqEditors ...RequestEditorFn) (*GetDataHolderStatusesResponse, error)

	// GetDataRecipients request
	GetDataRecipientsWithResponse(ctx context.Context, industry GetDataRecipientsParamsIndustry, params *GetDataRecipientsParams, reqEditors ...RequestEditorFn) (*GetDataRecipientsResponse, error)

	// GetSoftwareProductsStatuses request
	GetSoftwareProductsStatusesWithResponse(ctx context.Context, industry GetSoftwareProductsStatusesParamsIndustry, params *GetSoftwareProductsStatusesParams, reqEditors ...RequestEditorFn) (*GetSoftwareProductsStatusesResponse, error)

	// GetSoftwareStatementAssertion request
	GetSoftwareStatementAssertionWithResponse(ctx context.Context, industry GetSoftwareStatementAssertionParamsIndustry, dataRecipientBrandId string, softwareProductId string, params *GetSoftwareStatementAssertionParams, reqEditors ...RequestEditorFn) (*GetSoftwareStatementAssertionResponse, error)

	// GetDataRecipientsStatuses request
	GetDataRecipientsStatusesWithResponse(ctx context.Context, industry GetDataRecipientsStatusesParamsIndustry, params *GetDataRecipientsStatusesParams, reqEditors ...RequestEditorFn) (*GetDataRecipientsStatusesResponse, error)

	// GetJWKS request
	GetJWKSWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJWKSResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DataHolderBrandSummary 

type DataHolderBrandSummary struct {
	// Abn Australian Business Number for the organisation
	Abn *string `json:"abn,omitempty"`

	// Acn Australian Company Number for the organisation
	Acn *string `json:"acn,omitempty"`

	// Arbn Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies
	Arbn *string `json:"arbn,omitempty"`

	// BrandName The name of Data Holder Brand
	BrandName string `json:"brandName"`

	// DataHolderBrandId Unique id of the Data Holder Brand issued by the CDR Register
	DataHolderBrandId *string `json:"dataHolderBrandId,omitempty"`

	// Industries The industries the Data Holder Brand belongs to
	Industries []DataHolderBrandSummaryIndustries `json:"industries"`

	// InterimId Interim id of the Data Holder Brand issued by the CDR Register. This is to be used to uniquely identify the record when dataHolderBrandId is not populated and is not to be reused
	InterimId *string `json:"interimId,omitempty"`

	// LastUpdated The date/time that the Data Holder Brand data was last updated in the Register
	LastUpdated string `json:"lastUpdated"`

	// LogoUri Brand logo URI
	LogoUri string `json:"logoUri"`

	// PublicBaseUri Base URI for the Data Holder's Consumer Data Standard public endpoints
	PublicBaseUri string `json:"publicBaseUri"`
}

DataHolderBrandSummary defines model for DataHolderBrandSummary.

type DataHolderBrandSummaryIndustries 

type DataHolderBrandSummaryIndustries string

DataHolderBrandSummaryIndustries defines model for DataHolderBrandSummary.Industries. 

const (
	DataHolderBrandSummaryIndustriesBanking DataHolderBrandSummaryIndustries = "banking"
	DataHolderBrandSummaryIndustriesEnergy  DataHolderBrandSummaryIndustries = "energy"
	DataHolderBrandSummaryIndustriesTelco   DataHolderBrandSummaryIndustries = "telco"
)

Defines values for DataHolderBrandSummaryIndustries.

type DataHolderStatus 

type DataHolderStatus struct {
	// LegalEntityId Unique id of the Data Holder Legal Entity issued by the CDR Register.
	LegalEntityId string `json:"legalEntityId"`

	// Status Data Holder status in the CDR Register
	Status DataHolderStatusStatus `json:"status"`
}

DataHolderStatus defines model for DataHolderStatus.

type DataHolderStatusStatus 

type DataHolderStatusStatus string

DataHolderStatusStatus Data Holder status in the CDR Register 

const (
	DataHolderStatusStatusACTIVE  DataHolderStatusStatus = "ACTIVE"
	DataHolderStatusStatusREMOVED DataHolderStatusStatus = "REMOVED"
)

Defines values for DataHolderStatusStatus.

type DataHoldersStatusList 

type DataHoldersStatusList struct {
	// Data Response data for the query
	Data  []DataHolderStatus     `json:"data"`
	Links Links                  `json:"links"`
	Meta  map[string]interface{} `json:"meta"`
}

DataHoldersStatusList defines model for DataHoldersStatusList.

type DataRecipientBrandMetaData 

type DataRecipientBrandMetaData struct {
	// BrandName Data Recipient Brand name
	BrandName string `json:"brandName"`

	// DataRecipientBrandId Unique id of the Data Recipient brand issued by the CDR Register
	DataRecipientBrandId string `json:"dataRecipientBrandId"`

	// LogoUri Data Recipient Brand logo URI
	LogoUri          string                     `json:"logoUri"`
	SoftwareProducts *[]SoftwareProductMetaData `json:"softwareProducts,omitempty"`

	// Status Data Recipient Brand status in the CDR Register
	Status DataRecipientBrandMetaDataStatus `json:"status"`
}

DataRecipientBrandMetaData Metadata related to Data Recipient Brand

type DataRecipientBrandMetaDataStatus 

type DataRecipientBrandMetaDataStatus string

DataRecipientBrandMetaDataStatus Data Recipient Brand status in the CDR Register 

const (
	DataRecipientBrandMetaDataStatusACTIVE   DataRecipientBrandMetaDataStatus = "ACTIVE"
	DataRecipientBrandMetaDataStatusINACTIVE DataRecipientBrandMetaDataStatus = "INACTIVE"
	DataRecipientBrandMetaDataStatusREMOVED  DataRecipientBrandMetaDataStatus = "REMOVED"
)

Defines values for DataRecipientBrandMetaDataStatus.

type DataRecipientStatus 

type DataRecipientStatus struct {
	// LegalEntityId Unique id of the Data Recipient Legal Entity issued by the CDR Register
	LegalEntityId string `json:"legalEntityId"`

	// Status Data Recipient status in the CDR Register
	Status DataRecipientStatusStatus `json:"status"`
}

DataRecipientStatus defines model for DataRecipientStatus.

type DataRecipientStatusStatus 

type DataRecipientStatusStatus string

DataRecipientStatusStatus Data Recipient status in the CDR Register 

const (
	DataRecipientStatusStatusACTIVE      DataRecipientStatusStatus = "ACTIVE"
	DataRecipientStatusStatusREVOKED     DataRecipientStatusStatus = "REVOKED"
	DataRecipientStatusStatusSURRENDERED DataRecipientStatusStatus = "SURRENDERED"
	DataRecipientStatusStatusSUSPENDED   DataRecipientStatusStatus = "SUSPENDED"
)

Defines values for DataRecipientStatusStatus.

type DataRecipientsStatusList 

type DataRecipientsStatusList struct {
	// Data Response data for the query
	Data  []DataRecipientStatus  `json:"data"`
	Links Links                  `json:"links"`
	Meta  map[string]interface{} `json:"meta"`
}

DataRecipientsStatusList defines model for DataRecipientsStatusList.

type GetDataHolderBrandsParams 

type GetDataHolderBrandsParams struct {
	// UpdatedSince query filter returns results updated since the specified date-time
	UpdatedSince *string `form:"updated-since,omitempty" json:"updated-since,omitempty"`

	// Page the page number to return
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PageSize the number of records to return per page
	PageSize *int `form:"page-size,omitempty" json:"page-size,omitempty"`

	// Authorization An Authorisation Token as per **[[RFC6750]](#nref-RFC6750)**.
	Authorization string `json:"Authorization"`

	// XV The version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`
}

GetDataHolderBrandsParams defines parameters for GetDataHolderBrands.

type GetDataHolderBrandsParamsIndustry 

type GetDataHolderBrandsParamsIndustry string

GetDataHolderBrandsParamsIndustry defines parameters for GetDataHolderBrands. 

const (
	GetDataHolderBrandsParamsIndustryAll     GetDataHolderBrandsParamsIndustry = "all"
	GetDataHolderBrandsParamsIndustryBanking GetDataHolderBrandsParamsIndustry = "banking"
	GetDataHolderBrandsParamsIndustryEnergy  GetDataHolderBrandsParamsIndustry = "energy"
	GetDataHolderBrandsParamsIndustryTelco   GetDataHolderBrandsParamsIndustry = "telco"
)

Defines values for GetDataHolderBrandsParamsIndustry.

type GetDataHolderBrandsResponse 

type GetDataHolderBrandsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ResponseRegisterDataHolderBrandList
	JSON400      *ResponseErrorListV2
	JSON401      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetDataHolderBrandsResponse 

func ParseGetDataHolderBrandsResponse(rsp *http.Response) (*GetDataHolderBrandsResponse, error)

ParseGetDataHolderBrandsResponse parses an HTTP response from a GetDataHolderBrandsWithResponse call

func (GetDataHolderBrandsResponse) Status 

func (r GetDataHolderBrandsResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataHolderBrandsResponse) StatusCode 

func (r GetDataHolderBrandsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDataHolderBrandsSummaryParams 

type GetDataHolderBrandsSummaryParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer.
	XV int `json:"x-v"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// IfNoneMatch Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`
}

GetDataHolderBrandsSummaryParams defines parameters for GetDataHolderBrandsSummary.

type GetDataHolderBrandsSummaryParamsIndustry 

type GetDataHolderBrandsSummaryParamsIndustry string

GetDataHolderBrandsSummaryParamsIndustry defines parameters for GetDataHolderBrandsSummary. 

const (
	GetDataHolderBrandsSummaryParamsIndustryAll     GetDataHolderBrandsSummaryParamsIndustry = "all"
	GetDataHolderBrandsSummaryParamsIndustryBanking GetDataHolderBrandsSummaryParamsIndustry = "banking"
	GetDataHolderBrandsSummaryParamsIndustryEnergy  GetDataHolderBrandsSummaryParamsIndustry = "energy"
	GetDataHolderBrandsSummaryParamsIndustryTelco   GetDataHolderBrandsSummaryParamsIndustry = "telco"
)

Defines values for GetDataHolderBrandsSummaryParamsIndustry.

type GetDataHolderBrandsSummaryResponse 

type GetDataHolderBrandsSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ResponseDataHoldersBrandSummaryList
	JSON400      *ResponseErrorListV2
	JSON404      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetDataHolderBrandsSummaryResponse 

func ParseGetDataHolderBrandsSummaryResponse(rsp *http.Response) (*GetDataHolderBrandsSummaryResponse, error)

ParseGetDataHolderBrandsSummaryResponse parses an HTTP response from a GetDataHolderBrandsSummaryWithResponse call

func (GetDataHolderBrandsSummaryResponse) Status 

func (r GetDataHolderBrandsSummaryResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataHolderBrandsSummaryResponse) StatusCode 

func (r GetDataHolderBrandsSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDataHolderStatusesParams 

type GetDataHolderStatusesParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// IfNoneMatch Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`
}

GetDataHolderStatusesParams defines parameters for GetDataHolderStatuses.

type GetDataHolderStatusesParamsIndustry 

type GetDataHolderStatusesParamsIndustry string

GetDataHolderStatusesParamsIndustry defines parameters for GetDataHolderStatuses. 

const (
	GetDataHolderStatusesParamsIndustryAll     GetDataHolderStatusesParamsIndustry = "all"
	GetDataHolderStatusesParamsIndustryBanking GetDataHolderStatusesParamsIndustry = "banking"
	GetDataHolderStatusesParamsIndustryEnergy  GetDataHolderStatusesParamsIndustry = "energy"
	GetDataHolderStatusesParamsIndustryTelco   GetDataHolderStatusesParamsIndustry = "telco"
)

Defines values for GetDataHolderStatusesParamsIndustry.

type GetDataHolderStatusesResponse 

type GetDataHolderStatusesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataHoldersStatusList
	JSON400      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetDataHolderStatusesResponse 

func ParseGetDataHolderStatusesResponse(rsp *http.Response) (*GetDataHolderStatusesResponse, error)

ParseGetDataHolderStatusesResponse parses an HTTP response from a GetDataHolderStatusesWithResponse call

func (GetDataHolderStatusesResponse) Status 

func (r GetDataHolderStatusesResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataHolderStatusesResponse) StatusCode 

func (r GetDataHolderStatusesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDataRecipientsParams 

type GetDataRecipientsParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 2 if absent. Note that once version 2 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// IfNoneMatch Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`
}

GetDataRecipientsParams defines parameters for GetDataRecipients.

type GetDataRecipientsParamsIndustry 

type GetDataRecipientsParamsIndustry string

GetDataRecipientsParamsIndustry defines parameters for GetDataRecipients. 

const (
	GetDataRecipientsParamsIndustryAll     GetDataRecipientsParamsIndustry = "all"
	GetDataRecipientsParamsIndustryBanking GetDataRecipientsParamsIndustry = "banking"
	GetDataRecipientsParamsIndustryEnergy  GetDataRecipientsParamsIndustry = "energy"
	GetDataRecipientsParamsIndustryTelco   GetDataRecipientsParamsIndustry = "telco"
)

Defines values for GetDataRecipientsParamsIndustry.

type GetDataRecipientsResponse 

type GetDataRecipientsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ResponseRegisterDataRecipientList
	JSON400      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetDataRecipientsResponse 

func ParseGetDataRecipientsResponse(rsp *http.Response) (*GetDataRecipientsResponse, error)

ParseGetDataRecipientsResponse parses an HTTP response from a GetDataRecipientsWithResponse call

func (GetDataRecipientsResponse) Status 

func (r GetDataRecipientsResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataRecipientsResponse) StatusCode 

func (r GetDataRecipientsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDataRecipientsStatusesParams 

type GetDataRecipientsStatusesParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// IfNoneMatch Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`
}

GetDataRecipientsStatusesParams defines parameters for GetDataRecipientsStatuses.

type GetDataRecipientsStatusesParamsIndustry 

type GetDataRecipientsStatusesParamsIndustry string

GetDataRecipientsStatusesParamsIndustry defines parameters for GetDataRecipientsStatuses. 

const (
	All     GetDataRecipientsStatusesParamsIndustry = "all"
	Banking GetDataRecipientsStatusesParamsIndustry = "banking"
	Energy  GetDataRecipientsStatusesParamsIndustry = "energy"
	Telco   GetDataRecipientsStatusesParamsIndustry = "telco"
)

Defines values for GetDataRecipientsStatusesParamsIndustry.

type GetDataRecipientsStatusesResponse 

type GetDataRecipientsStatusesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataRecipientsStatusList
	JSON400      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetDataRecipientsStatusesResponse 

func ParseGetDataRecipientsStatusesResponse(rsp *http.Response) (*GetDataRecipientsStatusesResponse, error)

ParseGetDataRecipientsStatusesResponse parses an HTTP response from a GetDataRecipientsStatusesWithResponse call

func (GetDataRecipientsStatusesResponse) Status 

func (r GetDataRecipientsStatusesResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataRecipientsStatusesResponse) StatusCode 

func (r GetDataRecipientsStatusesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJWKSResponse 

type GetJWKSResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ResponseJWKS
}

func ParseGetJWKSResponse 

func ParseGetJWKSResponse(rsp *http.Response) (*GetJWKSResponse, error)

ParseGetJWKSResponse parses an HTTP response from a GetJWKSWithResponse call

func (GetJWKSResponse) Status 

func (r GetJWKSResponse) Status() string

Status returns HTTPResponse.Status

func (GetJWKSResponse) StatusCode 

func (r GetJWKSResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOpenIdProviderConfigResponse 

type GetOpenIdProviderConfigResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ResponseOpenIDProviderConfigMetadata
}

func ParseGetOpenIdProviderConfigResponse 

func ParseGetOpenIdProviderConfigResponse(rsp *http.Response) (*GetOpenIdProviderConfigResponse, error)

ParseGetOpenIdProviderConfigResponse parses an HTTP response from a GetOpenIdProviderConfigWithResponse call

func (GetOpenIdProviderConfigResponse) Status 

func (r GetOpenIdProviderConfigResponse) Status() string

Status returns HTTPResponse.Status

func (GetOpenIdProviderConfigResponse) StatusCode 

func (r GetOpenIdProviderConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSoftwareProductsStatusesParams 

type GetSoftwareProductsStatusesParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// IfNoneMatch Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
	IfNoneMatch *string `json:"If-None-Match,omitempty"`
}

GetSoftwareProductsStatusesParams defines parameters for GetSoftwareProductsStatuses.

type GetSoftwareProductsStatusesParamsIndustry 

type GetSoftwareProductsStatusesParamsIndustry string

GetSoftwareProductsStatusesParamsIndustry defines parameters for GetSoftwareProductsStatuses. 

const (
	GetSoftwareProductsStatusesParamsIndustryAll     GetSoftwareProductsStatusesParamsIndustry = "all"
	GetSoftwareProductsStatusesParamsIndustryBanking GetSoftwareProductsStatusesParamsIndustry = "banking"
	GetSoftwareProductsStatusesParamsIndustryEnergy  GetSoftwareProductsStatusesParamsIndustry = "energy"
	GetSoftwareProductsStatusesParamsIndustryTelco   GetSoftwareProductsStatusesParamsIndustry = "telco"
)

Defines values for GetSoftwareProductsStatusesParamsIndustry.

type GetSoftwareProductsStatusesResponse 

type GetSoftwareProductsStatusesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SoftwareProductsStatusList
	JSON400      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
}

func ParseGetSoftwareProductsStatusesResponse 

func ParseGetSoftwareProductsStatusesResponse(rsp *http.Response) (*GetSoftwareProductsStatusesResponse, error)

ParseGetSoftwareProductsStatusesResponse parses an HTTP response from a GetSoftwareProductsStatusesWithResponse call

func (GetSoftwareProductsStatusesResponse) Status 

func (r GetSoftwareProductsStatusesResponse) Status() string

Status returns HTTPResponse.Status

func (GetSoftwareProductsStatusesResponse) StatusCode 

func (r GetSoftwareProductsStatusesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSoftwareStatementAssertionParams 

type GetSoftwareStatementAssertionParams struct {
	// XV The version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
	XV *int `json:"x-v,omitempty"`

	// XMinV The [minimum version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point requested by the client. Must be set to a positive integer if provided.
	XMinV *int `json:"x-min-v,omitempty"`

	// Authorization An Authorisation Token as per **[[RFC6750]](#nref-RFC6750)**.
	Authorization string `json:"Authorization"`
}

GetSoftwareStatementAssertionParams defines parameters for GetSoftwareStatementAssertion.

type GetSoftwareStatementAssertionParamsIndustry 

type GetSoftwareStatementAssertionParamsIndustry string

GetSoftwareStatementAssertionParamsIndustry defines parameters for GetSoftwareStatementAssertion. 

const (
	GetSoftwareStatementAssertionParamsIndustryAll     GetSoftwareStatementAssertionParamsIndustry = "all"
	GetSoftwareStatementAssertionParamsIndustryBanking GetSoftwareStatementAssertionParamsIndustry = "banking"
	GetSoftwareStatementAssertionParamsIndustryEnergy  GetSoftwareStatementAssertionParamsIndustry = "energy"
	GetSoftwareStatementAssertionParamsIndustryTelco   GetSoftwareStatementAssertionParamsIndustry = "telco"
)

Defines values for GetSoftwareStatementAssertionParamsIndustry.

type GetSoftwareStatementAssertionResponse 

type GetSoftwareStatementAssertionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *string
	JSON400      *ResponseErrorListV2
	JSON401      *ResponseErrorListV2
	JSON403      *ResponseErrorListV2
	JSON404      *ResponseErrorListV2
	JSON406      *ResponseErrorListV2
	JSON422      *ResponseErrorListV2
}

func ParseGetSoftwareStatementAssertionResponse 

func ParseGetSoftwareStatementAssertionResponse(rsp *http.Response) (*GetSoftwareStatementAssertionResponse, error)

ParseGetSoftwareStatementAssertionResponse parses an HTTP response from a GetSoftwareStatementAssertionWithResponse call

func (GetSoftwareStatementAssertionResponse) Status 

func (r GetSoftwareStatementAssertionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSoftwareStatementAssertionResponse) StatusCode 

func (r GetSoftwareStatementAssertionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JWK 

type JWK struct {
	// Alg The "alg" (algorithm) parameter identifies the algorithm intended for use with the key
	Alg string `json:"alg"`

	// E The "e" RSA public exponent parameter
	E string `json:"e"`

	// KeyOps The "key_ops" (key operations) parameter identifies the operation(s) for which the key is intended to be used
	KeyOps []string `json:"key_ops"`

	// Kid The "kid" (key ID) parameter is partially used to match a specific key. Note the "kid" parameter is not guaranteed unique and additional parameters should be used to progressively to identify a key within a set
	Kid string `json:"kid"`

	// Kty The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key
	Kty string `json:"kty"`

	// N The "n" RSA public modulus parameter
	N string `json:"n"`
}

JWK Object representing a JSON Web Key

type LegalEntityDetail 

type LegalEntityDetail struct {
	// Abn Australian Business Number for the organisation
	Abn *string `json:"abn,omitempty"`

	// Acn Australian Company Number for the organisation
	Acn *string `json:"acn,omitempty"`

	// AnzsicDivision ANZSIC division of the organisation. **[[ANZSIC-2006]](#iref-ANZSIC-2006)**
	AnzsicDivision *string `json:"anzsicDivision,omitempty"`

	// Arbn Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies
	Arbn *string `json:"arbn,omitempty"`

	// LegalEntityId Unique id of the organisation issued by the CDR Register
	LegalEntityId string `json:"legalEntityId"`

	// LegalEntityName Unique legal name of the organisation
	LegalEntityName string `json:"legalEntityName"`

	// LogoUri Legal Entity logo URI
	LogoUri string `json:"logoUri"`

	// OrganisationType Legal organisation type
	OrganisationType *LegalEntityDetailOrganisationType `json:"organisationType,omitempty"`

	// RegisteredCountry Country of registeration (if the company is registered outside Australia)
	RegisteredCountry *string `json:"registeredCountry,omitempty"`

	// RegistrationDate Date of registration (if the company is registered outside Australia)
	RegistrationDate *string `json:"registrationDate,omitempty"`

	// RegistrationNumber Unique registration number (if the company is registered outside Australia)
	RegistrationNumber *string                 `json:"registrationNumber,omitempty"`
	Status             LegalEntityDetailStatus `json:"status"`
}

LegalEntityDetail The data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government)

type LegalEntityDetailOrganisationType 

type LegalEntityDetailOrganisationType string

LegalEntityDetailOrganisationType Legal organisation type 

const (
	COMPANY          LegalEntityDetailOrganisationType = "COMPANY"
	GOVERNMENTENTITY LegalEntityDetailOrganisationType = "GOVERNMENT_ENTITY"
	OTHER            LegalEntityDetailOrganisationType = "OTHER"
	PARTNERSHIP      LegalEntityDetailOrganisationType = "PARTNERSHIP"
	SOLETRADER       LegalEntityDetailOrganisationType = "SOLE_TRADER"
	TRUST            LegalEntityDetailOrganisationType = "TRUST"
)

Defines values for LegalEntityDetailOrganisationType.

type LegalEntityDetailStatus 

type LegalEntityDetailStatus string

LegalEntityDetailStatus defines model for LegalEntityDetail.Status. 

const (
	LegalEntityDetailStatusACTIVE  LegalEntityDetailStatus = "ACTIVE"
	LegalEntityDetailStatusREMOVED LegalEntityDetailStatus = "REMOVED"
)

Defines values for LegalEntityDetailStatus. 

type Links struct {
	// Self Fully qualified link to this API call
	Self string `json:"self"`
}

Links defines model for Links.

type LinksPaginated 

type LinksPaginated struct {
	// First URI to the first page of this set. Mandatory if this response is not the first page
	First *string `json:"first,omitempty"`

	// Last URI to the last page of this set. Mandatory if this response is not the last page
	Last *string `json:"last,omitempty"`

	// Next URI to the next page of this set. Mandatory if this response is not the last page
	Next *string `json:"next,omitempty"`

	// Prev URI to the previous page of this set. Mandatory if this response is not the first page
	Prev *string `json:"prev,omitempty"`

	// Self Fully qualified link to this API call
	Self string `json:"self"`
}

LinksPaginated defines model for LinksPaginated.

type MetaError 

type MetaError struct {
	// Urn The CDR error code URN which the application-specific error code extends. Mandatory if the error `code` is an application-specific error rather than a standardised error code.
	Urn *string `json:"urn,omitempty"`
}

MetaError Additional data for customised error codes

type MetaPaginated 

type MetaPaginated struct {
	// TotalPages The total number of pages in the full set
	TotalPages int `json:"totalPages"`

	// TotalRecords The total number of records in the full set
	TotalRecords int `json:"totalRecords"`
}

MetaPaginated defines model for MetaPaginated.

type RegisterDataHolderAuth 

type RegisterDataHolderAuth struct {
	// JwksEndpoint JWKS endpoint used for authentication by the Data Holder with the Data Recipient
	JwksEndpoint string `json:"jwksEndpoint"`

	// RegisterUType The type of authentication and authorisation mechanism in use
	RegisterUType RegisterDataHolderAuthRegisterUType `json:"registerUType"`
}

RegisterDataHolderAuth Defines the mechanism used and associated endpoints for Data Holder to Data Recipient authentication

type RegisterDataHolderAuthRegisterUType 

type RegisterDataHolderAuthRegisterUType string

RegisterDataHolderAuthRegisterUType The type of authentication and authorisation mechanism in use 

const (
	SIGNEDJWT RegisterDataHolderAuthRegisterUType = "SIGNED-JWT"
)

Defines values for RegisterDataHolderAuthRegisterUType.

type RegisterDataHolderBrand 

type RegisterDataHolderBrand struct {
	AuthDetails []RegisterDataHolderAuth `json:"authDetails"`

	// BrandName The name of Data Holder Brand
	BrandName string `json:"brandName"`

	// DataHolderBrandId Unique id of the Data Holder Brand issued by the CDR Register
	DataHolderBrandId string `json:"dataHolderBrandId"`

	// EndpointDetail Endpoints related to Data Holder Brand services
	EndpointDetail RegisterDataHolderBrandServiceEndpoint `json:"endpointDetail"`

	// Industries The industries the Data Holder Brand belongs to
	Industries []RegisterDataHolderBrandIndustries `json:"industries"`

	// LastUpdated The date/time that the Data Holder Brand data was last updated in the Register
	LastUpdated string `json:"lastUpdated"`

	// LegalEntity The data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government)
	LegalEntity LegalEntityDetail `json:"legalEntity"`

	// LogoUri Brand logo URI
	LogoUri string                        `json:"logoUri"`
	Status  RegisterDataHolderBrandStatus `json:"status"`
}

RegisterDataHolderBrand defines model for RegisterDataHolderBrand.

type RegisterDataHolderBrandIndustries 

type RegisterDataHolderBrandIndustries string

RegisterDataHolderBrandIndustries defines model for RegisterDataHolderBrand.Industries. 

const (
	RegisterDataHolderBrandIndustriesBanking RegisterDataHolderBrandIndustries = "banking"
	RegisterDataHolderBrandIndustriesEnergy  RegisterDataHolderBrandIndustries = "energy"
	RegisterDataHolderBrandIndustriesTelco   RegisterDataHolderBrandIndustries = "telco"
)

Defines values for RegisterDataHolderBrandIndustries.

type RegisterDataHolderBrandServiceEndpoint 

type RegisterDataHolderBrandServiceEndpoint struct {
	// ExtensionBaseUri Base URI for the Data Holder extension endpoints to the Consumer Data Standard (optional)
	ExtensionBaseUri *string `json:"extensionBaseUri,omitempty"`

	// InfosecBaseUri Base URI for the Data Holder's Consumer Data Standard information security endpoints
	InfosecBaseUri string `json:"infosecBaseUri"`

	// PublicBaseUri Base URI for the Data Holder's Consumer Data Standard public endpoints
	PublicBaseUri string `json:"publicBaseUri"`

	// ResourceBaseUri Base URI for the Data Holder's Consumer Data Standard resource endpoints
	ResourceBaseUri string `json:"resourceBaseUri"`

	// Version The major version of the high level standards. This is not the version of the endpoint or the payload being requested but the version of the overall standards being applied. This version number will be "v" followed by the major version of the standards as a positive integer (e.g. v1, v12 or v76)
	Version string `json:"version"`

	// WebsiteUri Publicly available website or web resource URI
	WebsiteUri string `json:"websiteUri"`
}

RegisterDataHolderBrandServiceEndpoint Endpoints related to Data Holder Brand services

type RegisterDataHolderBrandStatus 

type RegisterDataHolderBrandStatus string

RegisterDataHolderBrandStatus defines model for RegisterDataHolderBrand.Status. 

const (
	RegisterDataHolderBrandStatusACTIVE   RegisterDataHolderBrandStatus = "ACTIVE"
	RegisterDataHolderBrandStatusINACTIVE RegisterDataHolderBrandStatus = "INACTIVE"
	RegisterDataHolderBrandStatusREMOVED  RegisterDataHolderBrandStatus = "REMOVED"
)

Defines values for RegisterDataHolderBrandStatus.

type RegisterDataRecipient 

type RegisterDataRecipient struct {
	// AccreditationLevel Accreditation level of the Data Recipient in the CDR Register
	AccreditationLevel RegisterDataRecipientAccreditationLevel `json:"accreditationLevel"`

	// AccreditationNumber CDR Register issued human readable unique number given to Data Recipients upon accreditation
	AccreditationNumber string                        `json:"accreditationNumber"`
	DataRecipientBrands *[]DataRecipientBrandMetaData `json:"dataRecipientBrands,omitempty"`

	// LastUpdated The date/time that the Legal Entity was last updated in the CDR Register
	LastUpdated string `json:"lastUpdated"`

	// LegalEntityId Unique id of the Data Recipient Legal Entity issued by the CDR Register.
	LegalEntityId string `json:"legalEntityId"`

	// LegalEntityName Legal name of the Data Recipient
	LegalEntityName string `json:"legalEntityName"`

	// LogoUri Legal Entity logo URI
	LogoUri string `json:"logoUri"`

	// Status Data Recipient status in the CDR Register
	Status RegisterDataRecipientStatus `json:"status"`
}

RegisterDataRecipient defines model for RegisterDataRecipient.

type RegisterDataRecipientAccreditationLevel 

type RegisterDataRecipientAccreditationLevel string

RegisterDataRecipientAccreditationLevel Accreditation level of the Data Recipient in the CDR Register 

const (
	UNRESTRICTED RegisterDataRecipientAccreditationLevel = "UNRESTRICTED"
)

Defines values for RegisterDataRecipientAccreditationLevel.

type RegisterDataRecipientStatus 

type RegisterDataRecipientStatus string

RegisterDataRecipientStatus Data Recipient status in the CDR Register 

const (
	RegisterDataRecipientStatusACTIVE      RegisterDataRecipientStatus = "ACTIVE"
	RegisterDataRecipientStatusREVOKED     RegisterDataRecipientStatus = "REVOKED"
	RegisterDataRecipientStatusSURRENDERED RegisterDataRecipientStatus = "SURRENDERED"
	RegisterDataRecipientStatusSUSPENDED   RegisterDataRecipientStatus = "SUSPENDED"
)

Defines values for RegisterDataRecipientStatus.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseDataHoldersBrandSummaryList 

type ResponseDataHoldersBrandSummaryList struct {
	// Data Response data for the query
	Data  []DataHolderBrandSummary `json:"data"`
	Links Links                    `json:"links"`
	Meta  map[string]interface{}   `json:"meta"`
}

ResponseDataHoldersBrandSummaryList defines model for ResponseDataHoldersBrandSummaryList.

type ResponseErrorListV2 

type ResponseErrorListV2 struct {
	Errors []ResponseErrorListV2Errors `json:"errors"`
}

ResponseErrorListV2 defines model for ResponseErrorListV2.

type ResponseErrorListV2Errors 

type ResponseErrorListV2Errors struct {
	// Code The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
	Code string `json:"code"`

	// Detail A human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail"`

	// Meta Additional data for customised error codes
	Meta *MetaError `json:"meta,omitempty"`

	// Title A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
	Title string `json:"title"`
}

ResponseErrorListV2Errors defines model for ResponseErrorListV2_errors.

type ResponseJWKS 

type ResponseJWKS struct {
	// Keys The value of the "keys" parameter is an array of JWK values
	Keys []JWK `json:"keys"`
}

ResponseJWKS Response containing the JSON Web Key Set

type ResponseOpenIDProviderConfigMetadata 

type ResponseOpenIDProviderConfigMetadata struct {
	// ClaimsSupported JSON array containing a list of the Claim Names of the Claims that the CDR Register supplies values for
	ClaimsSupported []string `json:"claims_supported"`

	// CodeChallengeMethodsSupported JSON array containing a list of Proof Key for Code Exchange (PKCE) **[[RFC7636]](#nref-RFC7636)** code challenge methods supported by this authorization server. Given the CDR Register does not support PKCE, this field can be safely ignored
	CodeChallengeMethodsSupported []string `json:"code_challenge_methods_supported"`

	// GrantTypesSupported JSON array containing a list of the OAuth 2.0 Grant Type values that the CDR Register supports
	GrantTypesSupported []string `json:"grant_types_supported"`

	// IdTokenSigningAlgValuesSupported JSON array containing a list of the JWS signing algorithms (alg values) supported by the CDR Register for the ID Token to encode the Claims in a JWT. Given the CDR Register does not issue ID tokens, this field can be safely ignored
	IdTokenSigningAlgValuesSupported []string `json:"id_token_signing_alg_values_supported"`

	// Issuer URL using the https scheme with no query or fragment component that the CDR Register asserts as its Issuer Identifier
	Issuer string `json:"issuer"`

	// JwksUri URL of the CDR Register's JSON Web Key Set **[[JWK]](#nref-JWK)** document. This contains the signing key(s) used to validate access tokens issued from the CDR Register. Note that this differs from the JWKS endpoint used to validate SSAs and CDR Register client authentication
	JwksUri string `json:"jwks_uri"`

	// ResponseTypesSupported JSON array containing a list of the OAuth 2.0 response_type values that the CDR Registrer supports
	ResponseTypesSupported []string `json:"response_types_supported"`

	// ScopesSupported JSON array containing a list of the OAuth 2.0 **[[RFC6749]](#nref-RFC6749)** scope values that the CDR Register supports
	ScopesSupported []string `json:"scopes_supported"`

	// SubjectTypesSupported JSON array containing a list of the Subject Identifier types that the CDR Register supports. Given the CDR Register does not issue ID tokens, this field can be safely ignored
	SubjectTypesSupported []string `json:"subject_types_supported"`

	// TlsClientCertificateBoundAccessTokens Boolean value indicating server support for mutual TLS client certificate bound access tokens
	TlsClientCertificateBoundAccessTokens bool `json:"tls_client_certificate_bound_access_tokens"`

	// TokenEndpoint URL of the CDR Register's OAuth 2.0 Token Endpoint
	TokenEndpoint string `json:"token_endpoint"`

	// TokenEndpointAuthMethodsSupported JSON array containing a list of Client Authentication methods supported by this Token Endpoint
	TokenEndpointAuthMethodsSupported []string `json:"token_endpoint_auth_methods_supported"`

	// TokenEndpointAuthSigningAlgValuesSupported JSON array containing a list of the JWS signing algorithms (alg values) supported by the token endpoint for the signature on the JWT **[[JWT]](#nref-JWT)** used to authenticate the client at the token endpoint for the "private_key_jwt" authentication method
	TokenEndpointAuthSigningAlgValuesSupported []string `json:"token_endpoint_auth_signing_alg_values_supported"`
}

ResponseOpenIDProviderConfigMetadata Response containing the Open ID Provider Configuration Metadata

type ResponseRegisterDataHolderBrandList 

type ResponseRegisterDataHolderBrandList struct {
	// Data Response data for the query
	Data  []RegisterDataHolderBrand `json:"data"`
	Links LinksPaginated            `json:"links"`
	Meta  MetaPaginated             `json:"meta"`
}

ResponseRegisterDataHolderBrandList Response containing a list of CDR Register Data Holder Brand objects

type ResponseRegisterDataRecipientList 

type ResponseRegisterDataRecipientList struct {
	// Data Response data for the query
	Data  []RegisterDataRecipient `json:"data"`
	Links Links                   `json:"links"`
	Meta  map[string]interface{}  `json:"meta"`
}

ResponseRegisterDataRecipientList Response containing a list of Data Recipients in the CDR Register

type SoftwareProductMetaData 

type SoftwareProductMetaData struct {
	// LogoUri Software product logo URI
	LogoUri string `json:"logoUri"`

	// SoftwareProductDescription Description of the software product
	SoftwareProductDescription string `json:"softwareProductDescription"`

	// SoftwareProductId Unique id of the Data Recipient software product issued by the CDR Register
	SoftwareProductId string `json:"softwareProductId"`

	// SoftwareProductName Name of the software product
	SoftwareProductName string `json:"softwareProductName"`

	// Status Software Product status in the CDR Register
	Status SoftwareProductMetaDataStatus `json:"status"`
}

SoftwareProductMetaData Data Recipient Brand Software Products

type SoftwareProductMetaDataStatus 

type SoftwareProductMetaDataStatus string

SoftwareProductMetaDataStatus Software Product status in the CDR Register 

const (
	SoftwareProductMetaDataStatusACTIVE   SoftwareProductMetaDataStatus = "ACTIVE"
	SoftwareProductMetaDataStatusINACTIVE SoftwareProductMetaDataStatus = "INACTIVE"
	SoftwareProductMetaDataStatusREMOVED  SoftwareProductMetaDataStatus = "REMOVED"
)

Defines values for SoftwareProductMetaDataStatus.

type SoftwareProductStatus 

type SoftwareProductStatus struct {
	// SoftwareProductId Unique id of the software product issued by the CDR Register
	SoftwareProductId string `json:"softwareProductId"`

	// Status Software product status in the CDR Register
	Status SoftwareProductStatusStatus `json:"status"`
}

SoftwareProductStatus defines model for SoftwareProductStatus.

type SoftwareProductStatusStatus 

type SoftwareProductStatusStatus string

SoftwareProductStatusStatus Software product status in the CDR Register 

const (
	SoftwareProductStatusStatusACTIVE   SoftwareProductStatusStatus = "ACTIVE"
	SoftwareProductStatusStatusINACTIVE SoftwareProductStatusStatus = "INACTIVE"
	SoftwareProductStatusStatusREMOVED  SoftwareProductStatusStatus = "REMOVED"
)

Defines values for SoftwareProductStatusStatus.

type SoftwareProductsStatusList 

type SoftwareProductsStatusList struct {
	// Data Response data for the query
	Data  []SoftwareProductStatus `json:"data"`
	Links Links                   `json:"links"`
	Meta  map[string]interface{}  `json:"meta"`
}

SoftwareProductsStatusList defines model for SoftwareProductsStatusList.

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.