mnq

type API struct {
	// contains filtered or unexported fields
}

type CreateCredentialRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// NamespaceID: namespace containing the Credential
	NamespaceID string `json:"namespace_id"`
	// Name: credential name
	Name string `json:"name"`
	// Permissions: list of permissions associated to this Credential
	// Precisely one of Permissions must be set.
	Permissions *Permissions `json:"permissions,omitempty"`
}

type CreateNamespaceRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// Name: namespace name
	Name string `json:"name"`
	// Protocol: namespace protocol
	//
	// Default value: unknown
	Protocol NamespaceProtocol `json:"protocol"`
	// ProjectID: project containing the Namespace
	ProjectID string `json:"project_id"`
}

type Credential struct {
	// ID: credential ID
	ID string `json:"id"`
	// Name: credential name
	Name string `json:"name"`
	// NamespaceID: namespace containing the Credential
	NamespaceID string `json:"namespace_id"`
	// Protocol: protocol associated to the Credential
	//
	// Default value: unknown
	Protocol NamespaceProtocol `json:"protocol"`
	// NatsCredentials: credentials file used to connect to the NATS service
	// Precisely one of NatsCredentials, SqsSnsCredentials must be set.
	NatsCredentials *CredentialNATSCredsFile `json:"nats_credentials,omitempty"`
	// SqsSnsCredentials: credential used to connect to the SQS/SNS service
	// Precisely one of NatsCredentials, SqsSnsCredentials must be set.
	SqsSnsCredentials *CredentialSQSSNSCreds `json:"sqs_sns_credentials,omitempty"`
}

type CredentialNATSCredsFile struct {
	// Content: raw content of the NATS credentials file
	Content string `json:"content"`
}

type CredentialSQSSNSCreds struct {
	// AccessKey: ID of the key
	AccessKey string `json:"access_key"`
	// SecretKey: secret value of the key
	SecretKey *string `json:"secret_key"`
	// Permissions: list of permissions associated to this Credential
	Permissions *Permissions `json:"permissions"`
}

type CredentialSummary struct {
	// ID: credential ID
	ID string `json:"id"`
	// Name: credential name
	Name string `json:"name"`
	// NamespaceID: namespace containing the Credential
	NamespaceID string `json:"namespace_id"`
	// Protocol: protocol associated to the Credential
	//
	// Default value: unknown
	Protocol NamespaceProtocol `json:"protocol"`
	// SqsSnsCredentials: credential used to connect to the SQS/SNS service
	// Precisely one of SqsSnsCredentials must be set.
	SqsSnsCredentials *CredentialSummarySQSSNSCreds `json:"sqs_sns_credentials,omitempty"`
}

type CredentialSummarySQSSNSCreds struct {
	// AccessKey: ID of the key
	AccessKey string `json:"access_key"`
	// Permissions: list of permissions associated to this Credential
	Permissions *Permissions `json:"permissions"`
}

type DeleteCredentialRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// CredentialID: ID of the Credential to delete
	CredentialID string `json:"-"`
}

type DeleteNamespaceRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// NamespaceID: ID of the Namespace to delete
	NamespaceID string `json:"-"`
}

type GetCredentialRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// CredentialID: ID of the Credential to get
	CredentialID string `json:"-"`
}

type GetNamespaceRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// NamespaceID: ID of the Namespace to get
	NamespaceID string `json:"-"`
}

type ListCredentialsRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// NamespaceID: namespace containing the Credential
	NamespaceID *string `json:"-"`
	// Page: indicate the page number of results to be returned
	Page *int32 `json:"-"`
	// PageSize: maximum number of results returned by page
	PageSize *uint32 `json:"-"`
	// OrderBy: field used for sorting results
	//
	// Default value: id_asc
	OrderBy ListCredentialsRequestOrderBy `json:"-"`
}

type ListCredentialsRequestOrderBy string

type ListCredentialsResponse struct {
	// TotalCount: total number of existing Credentials
	TotalCount uint32 `json:"total_count"`
	// Credentials: a page of Credentials
	Credentials []*CredentialSummary `json:"credentials"`
}

type ListNamespacesRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// OrganizationID: will list only the Namespaces owned by the specified organization
	OrganizationID *string `json:"-"`
	// ProjectID: will list only the Namespaces contained into the specified project
	ProjectID *string `json:"-"`
	// Page: indicate the page number of results to be returned
	Page *int32 `json:"-"`
	// PageSize: maximum number of results returned by page
	PageSize *uint32 `json:"-"`
	// OrderBy: field used for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListNamespacesRequestOrderBy `json:"-"`
}

type ListNamespacesRequestOrderBy string

type ListNamespacesResponse struct {
	// TotalCount: total number of existing Namespaces
	TotalCount uint32 `json:"total_count"`
	// Namespaces: a page of Namespaces
	Namespaces []*Namespace `json:"namespaces"`
}

type Namespace struct {
	// ID: namespace ID
	ID string `json:"id"`
	// Name: namespace name
	Name string `json:"name"`
	// Endpoint: endpoint of the service matching the Namespace protocol
	Endpoint string `json:"endpoint"`
	// Protocol: namespace protocol
	//
	// Default value: unknown
	Protocol NamespaceProtocol `json:"protocol"`
	// ProjectID: project containing the Namespace
	ProjectID string `json:"project_id"`
	// Region: region where the Namespace is deployed
	Region scw.Region `json:"region"`
	// CreatedAt: namespace creation date
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: namespace last modification date
	UpdatedAt *time.Time `json:"updated_at"`
}

type NamespaceProtocol string

type Permissions struct {
	// CanPublish: defines if user can publish messages to the service
	CanPublish *bool `json:"can_publish"`
	// CanReceive: defines if user can receive messages from the service
	CanReceive *bool `json:"can_receive"`
	// CanManage: defines if user can manage the associated resource(s)
	CanManage *bool `json:"can_manage"`
}

type UpdateCredentialRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// CredentialID: ID of the Credential to update
	CredentialID string `json:"-"`
	// Name: credential name
	Name *string `json:"name"`
	// Permissions: list of permissions associated to this Credential
	// Precisely one of Permissions must be set.
	Permissions *Permissions `json:"permissions,omitempty"`
}

type UpdateNamespaceRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`
	// NamespaceID: ID of the Namespace to update
	NamespaceID string `json:"namespace_id"`
	// Name: namespace name
	Name *string `json:"name"`
}