secrets_store

package
v6.5.0 Latest Latest
Warning

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

Go to latest
Published: Dec 18, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type QuotaGetParams

type QuotaGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type QuotaGetResponse

type QuotaGetResponse struct {
	Secrets QuotaGetResponseSecrets `json:"secrets,required"`
	JSON    quotaGetResponseJSON    `json:"-"`
}

func (*QuotaGetResponse) UnmarshalJSON

func (r *QuotaGetResponse) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelope

type QuotaGetResponseEnvelope struct {
	Errors   []QuotaGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []QuotaGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    QuotaGetResponseEnvelopeSuccess    `json:"success,required"`
	Result     QuotaGetResponse                   `json:"result"`
	ResultInfo QuotaGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       quotaGetResponseEnvelopeJSON       `json:"-"`
}

func (*QuotaGetResponseEnvelope) UnmarshalJSON

func (r *QuotaGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeErrors

type QuotaGetResponseEnvelopeErrors struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           QuotaGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             quotaGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*QuotaGetResponseEnvelopeErrors) UnmarshalJSON

func (r *QuotaGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeErrorsSource

type QuotaGetResponseEnvelopeErrorsSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    quotaGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*QuotaGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *QuotaGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeMessages

type QuotaGetResponseEnvelopeMessages struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           QuotaGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             quotaGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*QuotaGetResponseEnvelopeMessages) UnmarshalJSON

func (r *QuotaGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeMessagesSource

type QuotaGetResponseEnvelopeMessagesSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    quotaGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*QuotaGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *QuotaGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeResultInfo

type QuotaGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                `json:"total_count"`
	JSON       quotaGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*QuotaGetResponseEnvelopeResultInfo) UnmarshalJSON

func (r *QuotaGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type QuotaGetResponseEnvelopeSuccess

type QuotaGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	QuotaGetResponseEnvelopeSuccessTrue QuotaGetResponseEnvelopeSuccess = true
)

func (QuotaGetResponseEnvelopeSuccess) IsKnown

type QuotaGetResponseSecrets

type QuotaGetResponseSecrets struct {
	// The number of secrets the account is entitlted to use
	Quota float64 `json:"quota,required"`
	// The number of secrets the account is currently using
	Usage float64                     `json:"usage,required"`
	JSON  quotaGetResponseSecretsJSON `json:"-"`
}

func (*QuotaGetResponseSecrets) UnmarshalJSON

func (r *QuotaGetResponseSecrets) UnmarshalJSON(data []byte) (err error)

type QuotaService

type QuotaService struct {
	Options []option.RequestOption
}

QuotaService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewQuotaService method instead.

func NewQuotaService

func NewQuotaService(opts ...option.RequestOption) (r *QuotaService)

NewQuotaService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*QuotaService) Get

func (r *QuotaService) Get(ctx context.Context, query QuotaGetParams, opts ...option.RequestOption) (res *QuotaGetResponse, err error)

Lists the number of secrets used in the account.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SecretsStoreService

type SecretsStoreService struct {
	Options []option.RequestOption
	Stores  *StoreService
	Quota   *QuotaService
}

SecretsStoreService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSecretsStoreService method instead.

func NewSecretsStoreService

func NewSecretsStoreService(opts ...option.RequestOption) (r *SecretsStoreService)

NewSecretsStoreService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type StoreDeleteParams

type StoreDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type StoreDeleteResponse

type StoreDeleteResponse struct {
	// Store Identifier
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the store
	Name string                  `json:"name,required"`
	JSON storeDeleteResponseJSON `json:"-"`
}

func (*StoreDeleteResponse) UnmarshalJSON

func (r *StoreDeleteResponse) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelope

type StoreDeleteResponseEnvelope struct {
	Errors   []StoreDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []StoreDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    StoreDeleteResponseEnvelopeSuccess    `json:"success,required"`
	Result     StoreDeleteResponse                   `json:"result"`
	ResultInfo StoreDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       storeDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*StoreDeleteResponseEnvelope) UnmarshalJSON

func (r *StoreDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeErrors

type StoreDeleteResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           StoreDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             storeDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*StoreDeleteResponseEnvelopeErrors) UnmarshalJSON

func (r *StoreDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeErrorsSource

type StoreDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    storeDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*StoreDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *StoreDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeMessages

type StoreDeleteResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           StoreDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             storeDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*StoreDeleteResponseEnvelopeMessages) UnmarshalJSON

func (r *StoreDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeMessagesSource

type StoreDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    storeDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*StoreDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *StoreDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeResultInfo

type StoreDeleteResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                   `json:"total_count"`
	JSON       storeDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*StoreDeleteResponseEnvelopeResultInfo) UnmarshalJSON

func (r *StoreDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type StoreDeleteResponseEnvelopeSuccess

type StoreDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	StoreDeleteResponseEnvelopeSuccessTrue StoreDeleteResponseEnvelopeSuccess = true
)

func (StoreDeleteResponseEnvelopeSuccess) IsKnown

type StoreListParams

type StoreListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Direction to sort objects
	Direction param.Field[StoreListParamsDirection] `query:"direction"`
	// Order secrets by values in the given field
	Order param.Field[StoreListParamsOrder] `query:"order"`
	// Page number
	Page param.Field[int64] `query:"page"`
	// Number of objects to return per page
	PerPage param.Field[int64] `query:"per_page"`
}

func (StoreListParams) URLQuery

func (r StoreListParams) URLQuery() (v url.Values)

URLQuery serializes StoreListParams's query parameters as `url.Values`.

type StoreListParamsDirection

type StoreListParamsDirection string

Direction to sort objects

const (
	StoreListParamsDirectionAsc  StoreListParamsDirection = "asc"
	StoreListParamsDirectionDesc StoreListParamsDirection = "desc"
)

func (StoreListParamsDirection) IsKnown

func (r StoreListParamsDirection) IsKnown() bool

type StoreListParamsOrder

type StoreListParamsOrder string

Order secrets by values in the given field

const (
	StoreListParamsOrderName     StoreListParamsOrder = "name"
	StoreListParamsOrderComment  StoreListParamsOrder = "comment"
	StoreListParamsOrderCreated  StoreListParamsOrder = "created"
	StoreListParamsOrderModified StoreListParamsOrder = "modified"
	StoreListParamsOrderStatus   StoreListParamsOrder = "status"
)

func (StoreListParamsOrder) IsKnown

func (r StoreListParamsOrder) IsKnown() bool

type StoreListResponse

type StoreListResponse struct {
	// Store Identifier
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the store
	Name string                `json:"name,required"`
	JSON storeListResponseJSON `json:"-"`
}

func (*StoreListResponse) UnmarshalJSON

func (r *StoreListResponse) UnmarshalJSON(data []byte) (err error)

type StoreNewParams

type StoreNewParams struct {
	// Account Identifier
	AccountID param.Field[string]  `path:"account_id,required"`
	Body      []StoreNewParamsBody `json:"body,required"`
}

func (StoreNewParams) MarshalJSON

func (r StoreNewParams) MarshalJSON() (data []byte, err error)

type StoreNewParamsBody

type StoreNewParamsBody struct {
	// The name of the store
	Name param.Field[string] `json:"name,required"`
}

func (StoreNewParamsBody) MarshalJSON

func (r StoreNewParamsBody) MarshalJSON() (data []byte, err error)

type StoreNewResponse

type StoreNewResponse struct {
	// Store Identifier
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the store
	Name string               `json:"name,required"`
	JSON storeNewResponseJSON `json:"-"`
}

func (*StoreNewResponse) UnmarshalJSON

func (r *StoreNewResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretBulkDeleteParams

type StoreSecretBulkDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type StoreSecretBulkDeleteResponse

type StoreSecretBulkDeleteResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                              `json:"name,required"`
	Status StoreSecretBulkDeleteResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                            `json:"comment"`
	JSON    storeSecretBulkDeleteResponseJSON `json:"-"`
}

func (*StoreSecretBulkDeleteResponse) UnmarshalJSON

func (r *StoreSecretBulkDeleteResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretBulkDeleteResponseStatus

type StoreSecretBulkDeleteResponseStatus string
const (
	StoreSecretBulkDeleteResponseStatusPending StoreSecretBulkDeleteResponseStatus = "pending"
	StoreSecretBulkDeleteResponseStatusActive  StoreSecretBulkDeleteResponseStatus = "active"
	StoreSecretBulkDeleteResponseStatusDeleted StoreSecretBulkDeleteResponseStatus = "deleted"
)

func (StoreSecretBulkDeleteResponseStatus) IsKnown

type StoreSecretDeleteParams

type StoreSecretDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type StoreSecretDeleteResponse

type StoreSecretDeleteResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                          `json:"name,required"`
	Status StoreSecretDeleteResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                        `json:"comment"`
	JSON    storeSecretDeleteResponseJSON `json:"-"`
}

func (*StoreSecretDeleteResponse) UnmarshalJSON

func (r *StoreSecretDeleteResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelope

type StoreSecretDeleteResponseEnvelope struct {
	Errors   []StoreSecretDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []StoreSecretDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    StoreSecretDeleteResponseEnvelopeSuccess    `json:"success,required"`
	Result     StoreSecretDeleteResponse                   `json:"result"`
	ResultInfo StoreSecretDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       storeSecretDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelope) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeErrors

type StoreSecretDeleteResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           StoreSecretDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             storeSecretDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelopeErrors) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeErrorsSource

type StoreSecretDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    storeSecretDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeMessages

type StoreSecretDeleteResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           StoreSecretDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             storeSecretDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelopeMessages) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeMessagesSource

type StoreSecretDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    storeSecretDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeResultInfo

type StoreSecretDeleteResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                         `json:"total_count"`
	JSON       storeSecretDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*StoreSecretDeleteResponseEnvelopeResultInfo) UnmarshalJSON

func (r *StoreSecretDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type StoreSecretDeleteResponseEnvelopeSuccess

type StoreSecretDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	StoreSecretDeleteResponseEnvelopeSuccessTrue StoreSecretDeleteResponseEnvelopeSuccess = true
)

func (StoreSecretDeleteResponseEnvelopeSuccess) IsKnown

type StoreSecretDeleteResponseStatus

type StoreSecretDeleteResponseStatus string
const (
	StoreSecretDeleteResponseStatusPending StoreSecretDeleteResponseStatus = "pending"
	StoreSecretDeleteResponseStatusActive  StoreSecretDeleteResponseStatus = "active"
	StoreSecretDeleteResponseStatusDeleted StoreSecretDeleteResponseStatus = "deleted"
)

func (StoreSecretDeleteResponseStatus) IsKnown

type StoreSecretDuplicateParams

type StoreSecretDuplicateParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The name of the secret
	Name param.Field[string] `json:"name,required"`
	// The list of services that can use this secret.
	Scopes param.Field[[]string] `json:"scopes,required"`
	// Freeform text describing the secret
	Comment param.Field[string] `json:"comment"`
}

func (StoreSecretDuplicateParams) MarshalJSON

func (r StoreSecretDuplicateParams) MarshalJSON() (data []byte, err error)

type StoreSecretDuplicateResponse

type StoreSecretDuplicateResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                             `json:"name,required"`
	Status StoreSecretDuplicateResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                           `json:"comment"`
	JSON    storeSecretDuplicateResponseJSON `json:"-"`
}

func (*StoreSecretDuplicateResponse) UnmarshalJSON

func (r *StoreSecretDuplicateResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelope

type StoreSecretDuplicateResponseEnvelope struct {
	Errors   []StoreSecretDuplicateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []StoreSecretDuplicateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    StoreSecretDuplicateResponseEnvelopeSuccess    `json:"success,required"`
	Result     StoreSecretDuplicateResponse                   `json:"result"`
	ResultInfo StoreSecretDuplicateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       storeSecretDuplicateResponseEnvelopeJSON       `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelope) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeErrors

type StoreSecretDuplicateResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           StoreSecretDuplicateResponseEnvelopeErrorsSource `json:"source"`
	JSON             storeSecretDuplicateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelopeErrors) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeErrorsSource

type StoreSecretDuplicateResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    storeSecretDuplicateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeMessages

type StoreSecretDuplicateResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           StoreSecretDuplicateResponseEnvelopeMessagesSource `json:"source"`
	JSON             storeSecretDuplicateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelopeMessages) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeMessagesSource

type StoreSecretDuplicateResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    storeSecretDuplicateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeResultInfo

type StoreSecretDuplicateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                            `json:"total_count"`
	JSON       storeSecretDuplicateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*StoreSecretDuplicateResponseEnvelopeResultInfo) UnmarshalJSON

func (r *StoreSecretDuplicateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type StoreSecretDuplicateResponseEnvelopeSuccess

type StoreSecretDuplicateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	StoreSecretDuplicateResponseEnvelopeSuccessTrue StoreSecretDuplicateResponseEnvelopeSuccess = true
)

func (StoreSecretDuplicateResponseEnvelopeSuccess) IsKnown

type StoreSecretDuplicateResponseStatus

type StoreSecretDuplicateResponseStatus string
const (
	StoreSecretDuplicateResponseStatusPending StoreSecretDuplicateResponseStatus = "pending"
	StoreSecretDuplicateResponseStatusActive  StoreSecretDuplicateResponseStatus = "active"
	StoreSecretDuplicateResponseStatusDeleted StoreSecretDuplicateResponseStatus = "deleted"
)

func (StoreSecretDuplicateResponseStatus) IsKnown

type StoreSecretEditParams

type StoreSecretEditParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Freeform text describing the secret
	Comment param.Field[string] `json:"comment"`
	// The list of services that can use this secret.
	Scopes param.Field[[]string] `json:"scopes"`
}

func (StoreSecretEditParams) MarshalJSON

func (r StoreSecretEditParams) MarshalJSON() (data []byte, err error)

type StoreSecretEditResponse

type StoreSecretEditResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                        `json:"name,required"`
	Status StoreSecretEditResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                      `json:"comment"`
	JSON    storeSecretEditResponseJSON `json:"-"`
}

func (*StoreSecretEditResponse) UnmarshalJSON

func (r *StoreSecretEditResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelope

type StoreSecretEditResponseEnvelope struct {
	Errors   []StoreSecretEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []StoreSecretEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    StoreSecretEditResponseEnvelopeSuccess    `json:"success,required"`
	Result     StoreSecretEditResponse                   `json:"result"`
	ResultInfo StoreSecretEditResponseEnvelopeResultInfo `json:"result_info"`
	JSON       storeSecretEditResponseEnvelopeJSON       `json:"-"`
}

func (*StoreSecretEditResponseEnvelope) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeErrors

type StoreSecretEditResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           StoreSecretEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             storeSecretEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*StoreSecretEditResponseEnvelopeErrors) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeErrorsSource

type StoreSecretEditResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    storeSecretEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*StoreSecretEditResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeMessages

type StoreSecretEditResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           StoreSecretEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             storeSecretEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*StoreSecretEditResponseEnvelopeMessages) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeMessagesSource

type StoreSecretEditResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    storeSecretEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*StoreSecretEditResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeResultInfo

type StoreSecretEditResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                       `json:"total_count"`
	JSON       storeSecretEditResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*StoreSecretEditResponseEnvelopeResultInfo) UnmarshalJSON

func (r *StoreSecretEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type StoreSecretEditResponseEnvelopeSuccess

type StoreSecretEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	StoreSecretEditResponseEnvelopeSuccessTrue StoreSecretEditResponseEnvelopeSuccess = true
)

func (StoreSecretEditResponseEnvelopeSuccess) IsKnown

type StoreSecretEditResponseStatus

type StoreSecretEditResponseStatus string
const (
	StoreSecretEditResponseStatusPending StoreSecretEditResponseStatus = "pending"
	StoreSecretEditResponseStatusActive  StoreSecretEditResponseStatus = "active"
	StoreSecretEditResponseStatusDeleted StoreSecretEditResponseStatus = "deleted"
)

func (StoreSecretEditResponseStatus) IsKnown

func (r StoreSecretEditResponseStatus) IsKnown() bool

type StoreSecretGetParams

type StoreSecretGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type StoreSecretGetResponse

type StoreSecretGetResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                       `json:"name,required"`
	Status StoreSecretGetResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                     `json:"comment"`
	JSON    storeSecretGetResponseJSON `json:"-"`
}

func (*StoreSecretGetResponse) UnmarshalJSON

func (r *StoreSecretGetResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelope

type StoreSecretGetResponseEnvelope struct {
	Errors   []StoreSecretGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []StoreSecretGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success    StoreSecretGetResponseEnvelopeSuccess    `json:"success,required"`
	Result     StoreSecretGetResponse                   `json:"result"`
	ResultInfo StoreSecretGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       storeSecretGetResponseEnvelopeJSON       `json:"-"`
}

func (*StoreSecretGetResponseEnvelope) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeErrors

type StoreSecretGetResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           StoreSecretGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             storeSecretGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*StoreSecretGetResponseEnvelopeErrors) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeErrorsSource

type StoreSecretGetResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    storeSecretGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*StoreSecretGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeMessages

type StoreSecretGetResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           StoreSecretGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             storeSecretGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*StoreSecretGetResponseEnvelopeMessages) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeMessagesSource

type StoreSecretGetResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    storeSecretGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*StoreSecretGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeResultInfo

type StoreSecretGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                      `json:"total_count"`
	JSON       storeSecretGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*StoreSecretGetResponseEnvelopeResultInfo) UnmarshalJSON

func (r *StoreSecretGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type StoreSecretGetResponseEnvelopeSuccess

type StoreSecretGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	StoreSecretGetResponseEnvelopeSuccessTrue StoreSecretGetResponseEnvelopeSuccess = true
)

func (StoreSecretGetResponseEnvelopeSuccess) IsKnown

type StoreSecretGetResponseStatus

type StoreSecretGetResponseStatus string
const (
	StoreSecretGetResponseStatusPending StoreSecretGetResponseStatus = "pending"
	StoreSecretGetResponseStatusActive  StoreSecretGetResponseStatus = "active"
	StoreSecretGetResponseStatusDeleted StoreSecretGetResponseStatus = "deleted"
)

func (StoreSecretGetResponseStatus) IsKnown

func (r StoreSecretGetResponseStatus) IsKnown() bool

type StoreSecretListParams

type StoreSecretListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Direction to sort objects
	Direction param.Field[StoreSecretListParamsDirection] `query:"direction"`
	// Order secrets by values in the given field
	Order param.Field[StoreSecretListParamsOrder] `query:"order"`
	// Page number
	Page param.Field[int64] `query:"page"`
	// Number of objects to return per page
	PerPage param.Field[int64] `query:"per_page"`
	// Only secrets with the given scopes will be returned
	Scopes param.Field[[][]string] `query:"scopes"`
	// Search secrets using a filter string, filtering across name and comment
	Search param.Field[string] `query:"search"`
}

func (StoreSecretListParams) URLQuery

func (r StoreSecretListParams) URLQuery() (v url.Values)

URLQuery serializes StoreSecretListParams's query parameters as `url.Values`.

type StoreSecretListParamsDirection

type StoreSecretListParamsDirection string

Direction to sort objects

const (
	StoreSecretListParamsDirectionAsc  StoreSecretListParamsDirection = "asc"
	StoreSecretListParamsDirectionDesc StoreSecretListParamsDirection = "desc"
)

func (StoreSecretListParamsDirection) IsKnown

type StoreSecretListParamsOrder

type StoreSecretListParamsOrder string

Order secrets by values in the given field

const (
	StoreSecretListParamsOrderName     StoreSecretListParamsOrder = "name"
	StoreSecretListParamsOrderComment  StoreSecretListParamsOrder = "comment"
	StoreSecretListParamsOrderCreated  StoreSecretListParamsOrder = "created"
	StoreSecretListParamsOrderModified StoreSecretListParamsOrder = "modified"
	StoreSecretListParamsOrderStatus   StoreSecretListParamsOrder = "status"
)

func (StoreSecretListParamsOrder) IsKnown

func (r StoreSecretListParamsOrder) IsKnown() bool

type StoreSecretListResponse

type StoreSecretListResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                        `json:"name,required"`
	Status StoreSecretListResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                      `json:"comment"`
	JSON    storeSecretListResponseJSON `json:"-"`
}

func (*StoreSecretListResponse) UnmarshalJSON

func (r *StoreSecretListResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretListResponseStatus

type StoreSecretListResponseStatus string
const (
	StoreSecretListResponseStatusPending StoreSecretListResponseStatus = "pending"
	StoreSecretListResponseStatusActive  StoreSecretListResponseStatus = "active"
	StoreSecretListResponseStatusDeleted StoreSecretListResponseStatus = "deleted"
)

func (StoreSecretListResponseStatus) IsKnown

func (r StoreSecretListResponseStatus) IsKnown() bool

type StoreSecretNewParams

type StoreSecretNewParams struct {
	// Account Identifier
	AccountID param.Field[string]        `path:"account_id,required"`
	Body      []StoreSecretNewParamsBody `json:"body,required"`
}

func (StoreSecretNewParams) MarshalJSON

func (r StoreSecretNewParams) MarshalJSON() (data []byte, err error)

type StoreSecretNewParamsBody

type StoreSecretNewParamsBody struct {
	// The name of the secret
	Name param.Field[string] `json:"name,required"`
	// The list of services that can use this secret.
	Scopes param.Field[[]string] `json:"scopes,required"`
	// The value of the secret. Note that this is 'write only' - no API reponse will
	// provide this value, it is only used to create/modify secrets.
	Value param.Field[string] `json:"value,required"`
	// Freeform text describing the secret
	Comment param.Field[string] `json:"comment"`
}

func (StoreSecretNewParamsBody) MarshalJSON

func (r StoreSecretNewParamsBody) MarshalJSON() (data []byte, err error)

type StoreSecretNewResponse

type StoreSecretNewResponse struct {
	// Secret identifier tag.
	ID string `json:"id,required"`
	// Whenthe secret was created.
	Created time.Time `json:"created,required" format:"date-time"`
	// When the secret was modified.
	Modified time.Time `json:"modified,required" format:"date-time"`
	// The name of the secret
	Name   string                       `json:"name,required"`
	Status StoreSecretNewResponseStatus `json:"status,required"`
	// Store Identifier
	StoreID string `json:"store_id,required"`
	// Freeform text describing the secret
	Comment string                     `json:"comment"`
	JSON    storeSecretNewResponseJSON `json:"-"`
}

func (*StoreSecretNewResponse) UnmarshalJSON

func (r *StoreSecretNewResponse) UnmarshalJSON(data []byte) (err error)

type StoreSecretNewResponseStatus

type StoreSecretNewResponseStatus string
const (
	StoreSecretNewResponseStatusPending StoreSecretNewResponseStatus = "pending"
	StoreSecretNewResponseStatusActive  StoreSecretNewResponseStatus = "active"
	StoreSecretNewResponseStatusDeleted StoreSecretNewResponseStatus = "deleted"
)

func (StoreSecretNewResponseStatus) IsKnown

func (r StoreSecretNewResponseStatus) IsKnown() bool

type StoreSecretService

type StoreSecretService struct {
	Options []option.RequestOption
}

StoreSecretService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStoreSecretService method instead.

func NewStoreSecretService

func NewStoreSecretService(opts ...option.RequestOption) (r *StoreSecretService)

NewStoreSecretService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*StoreSecretService) BulkDelete

Deletes one or more secrets

func (*StoreSecretService) BulkDeleteAutoPaging

Deletes one or more secrets

func (*StoreSecretService) Delete

func (r *StoreSecretService) Delete(ctx context.Context, storeID string, secretID string, body StoreSecretDeleteParams, opts ...option.RequestOption) (res *StoreSecretDeleteResponse, err error)

Deletes a single secret

func (*StoreSecretService) Duplicate

func (r *StoreSecretService) Duplicate(ctx context.Context, storeID string, secretID string, params StoreSecretDuplicateParams, opts ...option.RequestOption) (res *StoreSecretDuplicateResponse, err error)

Duplicates the secret, keeping the value

func (*StoreSecretService) Edit

func (r *StoreSecretService) Edit(ctx context.Context, storeID string, secretID string, params StoreSecretEditParams, opts ...option.RequestOption) (res *StoreSecretEditResponse, err error)

Updates a single secret

func (*StoreSecretService) Get

func (r *StoreSecretService) Get(ctx context.Context, storeID string, secretID string, query StoreSecretGetParams, opts ...option.RequestOption) (res *StoreSecretGetResponse, err error)

Returns details of a single secret

func (*StoreSecretService) List

Lists all store secrets

func (*StoreSecretService) ListAutoPaging

Lists all store secrets

func (*StoreSecretService) New

Creates a secret in the account

func (*StoreSecretService) NewAutoPaging

Creates a secret in the account

type StoreService

type StoreService struct {
	Options []option.RequestOption
	Secrets *StoreSecretService
}

StoreService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStoreService method instead.

func NewStoreService

func NewStoreService(opts ...option.RequestOption) (r *StoreService)

NewStoreService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*StoreService) Delete

func (r *StoreService) Delete(ctx context.Context, storeID string, body StoreDeleteParams, opts ...option.RequestOption) (res *StoreDeleteResponse, err error)

Deletes a single store

func (*StoreService) List

Lists all the stores in an account

func (*StoreService) ListAutoPaging

Lists all the stores in an account

func (*StoreService) New

Creates a store in the account

func (*StoreService) NewAutoPaging

Creates a store in the account

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL