accounts

package
v2.0.0-beta.11 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	// Identifier
	ID string `json:"id,required"`
	// Account name
	Name string `json:"name,required"`
	// Timestamp for the creation of the account
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Account settings
	Settings AccountSettings `json:"settings"`
	JSON     accountJSON     `json:"-"`
}

func (*Account) UnmarshalJSON 

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

type AccountGetParams 

type AccountGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type AccountGetResponse added in v2.3.0 

type AccountGetResponse interface {
	ImplementsAccountsAccountGetResponse()
}

Union satisfied by accounts.AccountGetResponseUnknown or shared.UnionString.

type AccountGetResponseEnvelope 

type AccountGetResponseEnvelope struct {
	Errors   []AccountGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccountGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccountGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accountGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccountGetResponseEnvelope) UnmarshalJSON 

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

type AccountGetResponseEnvelopeErrors 

type AccountGetResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    accountGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccountGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccountGetResponseEnvelopeMessages 

type AccountGetResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    accountGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccountGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccountGetResponseEnvelopeSuccess 

type AccountGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccountGetResponseEnvelopeSuccessTrue AccountGetResponseEnvelopeSuccess = true
)

func (AccountGetResponseEnvelopeSuccess) IsKnown 

func (r AccountGetResponseEnvelopeSuccess) IsKnown() bool

type AccountListParams 

type AccountListParams struct {
	// Direction to order results.
	Direction param.Field[AccountListParamsDirection] `query:"direction"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (AccountListParams) URLQuery 

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

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

type AccountListParamsDirection 

type AccountListParamsDirection string

Direction to order results. 

const (
	AccountListParamsDirectionAsc  AccountListParamsDirection = "asc"
	AccountListParamsDirectionDesc AccountListParamsDirection = "desc"
)

func (AccountListParamsDirection) IsKnown 

func (r AccountListParamsDirection) IsKnown() bool

type AccountListResponse 

type AccountListResponse = interface{}

type AccountMember 

type AccountMember struct {
	// Membership identifier tag.
	ID string `json:"id,required"`
	// Roles assigned to this member.
	Roles  []AccountMemberRole `json:"roles,required"`
	Status interface{}         `json:"status,required"`
	User   AccountMemberUser   `json:"user,required"`
	JSON   accountMemberJSON   `json:"-"`
}

func (*AccountMember) UnmarshalJSON 

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

type AccountMemberRole 

type AccountMemberRole struct {
	// Role identifier tag.
	ID string `json:"id,required"`
	// Description of role's permissions.
	Description string `json:"description,required"`
	// Role name.
	Name        string                        `json:"name,required"`
	Permissions AccountMemberRolesPermissions `json:"permissions,required"`
	JSON        accountMemberRoleJSON         `json:"-"`
}

func (*AccountMemberRole) UnmarshalJSON 

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

type AccountMemberRolesPermissions 

type AccountMemberRolesPermissions struct {
	Analytics    AccountMemberRolesPermissionsAnalytics    `json:"analytics"`
	Billing      AccountMemberRolesPermissionsBilling      `json:"billing"`
	CachePurge   AccountMemberRolesPermissionsCachePurge   `json:"cache_purge"`
	DNS          AccountMemberRolesPermissionsDNS          `json:"dns"`
	DNSRecords   AccountMemberRolesPermissionsDNSRecords   `json:"dns_records"`
	Lb           AccountMemberRolesPermissionsLb           `json:"lb"`
	Logs         AccountMemberRolesPermissionsLogs         `json:"logs"`
	Organization AccountMemberRolesPermissionsOrganization `json:"organization"`
	SSL          AccountMemberRolesPermissionsSSL          `json:"ssl"`
	WAF          AccountMemberRolesPermissionsWAF          `json:"waf"`
	ZoneSettings AccountMemberRolesPermissionsZoneSettings `json:"zone_settings"`
	Zones        AccountMemberRolesPermissionsZones        `json:"zones"`
	JSON         accountMemberRolesPermissionsJSON         `json:"-"`
}

func (*AccountMemberRolesPermissions) UnmarshalJSON 

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

type AccountMemberRolesPermissionsAnalytics 

type AccountMemberRolesPermissionsAnalytics struct {
	Read  bool                                       `json:"read"`
	Write bool                                       `json:"write"`
	JSON  accountMemberRolesPermissionsAnalyticsJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsAnalytics) UnmarshalJSON 

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

type AccountMemberRolesPermissionsBilling 

type AccountMemberRolesPermissionsBilling struct {
	Read  bool                                     `json:"read"`
	Write bool                                     `json:"write"`
	JSON  accountMemberRolesPermissionsBillingJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsBilling) UnmarshalJSON 

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

type AccountMemberRolesPermissionsCachePurge 

type AccountMemberRolesPermissionsCachePurge struct {
	Read  bool                                        `json:"read"`
	Write bool                                        `json:"write"`
	JSON  accountMemberRolesPermissionsCachePurgeJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsCachePurge) UnmarshalJSON 

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

type AccountMemberRolesPermissionsDNS 

type AccountMemberRolesPermissionsDNS struct {
	Read  bool                                 `json:"read"`
	Write bool                                 `json:"write"`
	JSON  accountMemberRolesPermissionsDNSJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsDNS) UnmarshalJSON 

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

type AccountMemberRolesPermissionsDNSRecords 

type AccountMemberRolesPermissionsDNSRecords struct {
	Read  bool                                        `json:"read"`
	Write bool                                        `json:"write"`
	JSON  accountMemberRolesPermissionsDNSRecordsJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsDNSRecords) UnmarshalJSON 

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

type AccountMemberRolesPermissionsLb 

type AccountMemberRolesPermissionsLb struct {
	Read  bool                                `json:"read"`
	Write bool                                `json:"write"`
	JSON  accountMemberRolesPermissionsLbJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsLb) UnmarshalJSON 

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

type AccountMemberRolesPermissionsLogs 

type AccountMemberRolesPermissionsLogs struct {
	Read  bool                                  `json:"read"`
	Write bool                                  `json:"write"`
	JSON  accountMemberRolesPermissionsLogsJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsLogs) UnmarshalJSON 

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

type AccountMemberRolesPermissionsOrganization 

type AccountMemberRolesPermissionsOrganization struct {
	Read  bool                                          `json:"read"`
	Write bool                                          `json:"write"`
	JSON  accountMemberRolesPermissionsOrganizationJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsOrganization) UnmarshalJSON 

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

type AccountMemberRolesPermissionsSSL 

type AccountMemberRolesPermissionsSSL struct {
	Read  bool                                 `json:"read"`
	Write bool                                 `json:"write"`
	JSON  accountMemberRolesPermissionsSSLJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsSSL) UnmarshalJSON 

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

type AccountMemberRolesPermissionsWAF 

type AccountMemberRolesPermissionsWAF struct {
	Read  bool                                 `json:"read"`
	Write bool                                 `json:"write"`
	JSON  accountMemberRolesPermissionsWAFJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsWAF) UnmarshalJSON 

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

type AccountMemberRolesPermissionsZoneSettings 

type AccountMemberRolesPermissionsZoneSettings struct {
	Read  bool                                          `json:"read"`
	Write bool                                          `json:"write"`
	JSON  accountMemberRolesPermissionsZoneSettingsJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsZoneSettings) UnmarshalJSON 

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

type AccountMemberRolesPermissionsZones 

type AccountMemberRolesPermissionsZones struct {
	Read  bool                                   `json:"read"`
	Write bool                                   `json:"write"`
	JSON  accountMemberRolesPermissionsZonesJSON `json:"-"`
}

func (*AccountMemberRolesPermissionsZones) UnmarshalJSON 

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

type AccountMemberUser 

type AccountMemberUser struct {
	// The contact email address of the user.
	Email string `json:"email,required"`
	// Identifier
	ID string `json:"id"`
	// User's first name
	FirstName string `json:"first_name,nullable"`
	// User's last name
	LastName string `json:"last_name,nullable"`
	// Indicates whether two-factor authentication is enabled for the user account.
	// Does not apply to API authentication.
	TwoFactorAuthenticationEnabled bool                  `json:"two_factor_authentication_enabled"`
	JSON                           accountMemberUserJSON `json:"-"`
}

func (*AccountMemberUser) UnmarshalJSON 

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

type AccountMemberWithID 

type AccountMemberWithID struct {
	// Membership identifier tag.
	ID string `json:"id,required"`
	// Roles assigned to this member.
	Roles  []AccountMemberWithIDRole `json:"roles,required"`
	Status interface{}               `json:"status,required"`
	User   AccountMemberWithIDUser   `json:"user,required"`
	// The unique activation code for the account membership.
	Code string                  `json:"code"`
	JSON accountMemberWithIDJSON `json:"-"`
}

func (*AccountMemberWithID) UnmarshalJSON 

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

type AccountMemberWithIDRole 

type AccountMemberWithIDRole struct {
	// Role identifier tag.
	ID string `json:"id,required"`
	// Description of role's permissions.
	Description string `json:"description,required"`
	// Role name.
	Name        string                              `json:"name,required"`
	Permissions AccountMemberWithIDRolesPermissions `json:"permissions,required"`
	JSON        accountMemberWithIDRoleJSON         `json:"-"`
}

func (*AccountMemberWithIDRole) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissions 

type AccountMemberWithIDRolesPermissions struct {
	Analytics    AccountMemberWithIDRolesPermissionsAnalytics    `json:"analytics"`
	Billing      AccountMemberWithIDRolesPermissionsBilling      `json:"billing"`
	CachePurge   AccountMemberWithIDRolesPermissionsCachePurge   `json:"cache_purge"`
	DNS          AccountMemberWithIDRolesPermissionsDNS          `json:"dns"`
	DNSRecords   AccountMemberWithIDRolesPermissionsDNSRecords   `json:"dns_records"`
	Lb           AccountMemberWithIDRolesPermissionsLb           `json:"lb"`
	Logs         AccountMemberWithIDRolesPermissionsLogs         `json:"logs"`
	Organization AccountMemberWithIDRolesPermissionsOrganization `json:"organization"`
	SSL          AccountMemberWithIDRolesPermissionsSSL          `json:"ssl"`
	WAF          AccountMemberWithIDRolesPermissionsWAF          `json:"waf"`
	ZoneSettings AccountMemberWithIDRolesPermissionsZoneSettings `json:"zone_settings"`
	Zones        AccountMemberWithIDRolesPermissionsZones        `json:"zones"`
	JSON         accountMemberWithIDRolesPermissionsJSON         `json:"-"`
}

func (*AccountMemberWithIDRolesPermissions) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsAnalytics 

type AccountMemberWithIDRolesPermissionsAnalytics struct {
	Read  bool                                             `json:"read"`
	Write bool                                             `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsAnalyticsJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsAnalytics) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsBilling 

type AccountMemberWithIDRolesPermissionsBilling struct {
	Read  bool                                           `json:"read"`
	Write bool                                           `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsBillingJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsBilling) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsCachePurge 

type AccountMemberWithIDRolesPermissionsCachePurge struct {
	Read  bool                                              `json:"read"`
	Write bool                                              `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsCachePurgeJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsCachePurge) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsDNS 

type AccountMemberWithIDRolesPermissionsDNS struct {
	Read  bool                                       `json:"read"`
	Write bool                                       `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsDNSJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsDNS) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsDNSRecords 

type AccountMemberWithIDRolesPermissionsDNSRecords struct {
	Read  bool                                              `json:"read"`
	Write bool                                              `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsDNSRecordsJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsDNSRecords) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsLb 

type AccountMemberWithIDRolesPermissionsLb struct {
	Read  bool                                      `json:"read"`
	Write bool                                      `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsLbJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsLb) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsLogs 

type AccountMemberWithIDRolesPermissionsLogs struct {
	Read  bool                                        `json:"read"`
	Write bool                                        `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsLogsJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsLogs) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsOrganization 

type AccountMemberWithIDRolesPermissionsOrganization struct {
	Read  bool                                                `json:"read"`
	Write bool                                                `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsOrganizationJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsOrganization) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsSSL 

type AccountMemberWithIDRolesPermissionsSSL struct {
	Read  bool                                       `json:"read"`
	Write bool                                       `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsSSLJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsSSL) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsWAF 

type AccountMemberWithIDRolesPermissionsWAF struct {
	Read  bool                                       `json:"read"`
	Write bool                                       `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsWAFJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsWAF) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsZoneSettings 

type AccountMemberWithIDRolesPermissionsZoneSettings struct {
	Read  bool                                                `json:"read"`
	Write bool                                                `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsZoneSettingsJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsZoneSettings) UnmarshalJSON 

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

type AccountMemberWithIDRolesPermissionsZones 

type AccountMemberWithIDRolesPermissionsZones struct {
	Read  bool                                         `json:"read"`
	Write bool                                         `json:"write"`
	JSON  accountMemberWithIDRolesPermissionsZonesJSON `json:"-"`
}

func (*AccountMemberWithIDRolesPermissionsZones) UnmarshalJSON 

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

type AccountMemberWithIDUser 

type AccountMemberWithIDUser struct {
	// The contact email address of the user.
	Email string `json:"email,required"`
	// Identifier
	ID string `json:"id"`
	// User's first name
	FirstName string `json:"first_name,nullable"`
	// User's last name
	LastName string `json:"last_name,nullable"`
	// Indicates whether two-factor authentication is enabled for the user account.
	// Does not apply to API authentication.
	TwoFactorAuthenticationEnabled bool                        `json:"two_factor_authentication_enabled"`
	JSON                           accountMemberWithIDUserJSON `json:"-"`
}

func (*AccountMemberWithIDUser) UnmarshalJSON 

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

type AccountService 

type AccountService struct {
	Options []option.RequestOption
	Members *MemberService
	Roles   *RoleService
}

AccountService 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 NewAccountService method instead.

func NewAccountService 

func NewAccountService(opts ...option.RequestOption) (r *AccountService)

NewAccountService 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 (*AccountService) Get 

func (r *AccountService) Get(ctx context.Context, query AccountGetParams, opts ...option.RequestOption) (res *AccountGetResponse, err error)

Get information about a specific account that you are a member of.

func (*AccountService) List 

func (r *AccountService) List(ctx context.Context, query AccountListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[AccountListResponse], err error)

List all accounts you have ownership or verified access to.

func (*AccountService) ListAutoPaging 

func (r *AccountService) ListAutoPaging(ctx context.Context, query AccountListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[AccountListResponse]

List all accounts you have ownership or verified access to.

func (*AccountService) Update 

func (r *AccountService) Update(ctx context.Context, params AccountUpdateParams, opts ...option.RequestOption) (res *AccountUpdateResponse, err error)

Update an existing account.

type AccountSettings 

type AccountSettings struct {
	// Specifies the default nameservers to be used for new zones added to this
	// account.
	//
	// - `cloudflare.standard` for Cloudflare-branded nameservers
	// - `custom.account` for account custom nameservers
	// - `custom.tenant` for tenant custom nameservers
	//
	// See
	// [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)
	// for more information.
	DefaultNameservers AccountSettingsDefaultNameservers `json:"default_nameservers"`
	// Indicates whether membership in this account requires that Two-Factor
	// Authentication is enabled
	EnforceTwofactor bool `json:"enforce_twofactor"`
	// Indicates whether new zones should use the account-level custom nameservers by
	// default.
	//
	// Deprecated in favor of `default_nameservers`.
	UseAccountCustomNSByDefault bool                `json:"use_account_custom_ns_by_default"`
	JSON                        accountSettingsJSON `json:"-"`
}

Account settings

func (*AccountSettings) UnmarshalJSON 

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

type AccountSettingsDefaultNameservers 

type AccountSettingsDefaultNameservers string

Specifies the default nameservers to be used for new zones added to this account.

- `cloudflare.standard` for Cloudflare-branded nameservers - `custom.account` for account custom nameservers - `custom.tenant` for tenant custom nameservers

See [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/) for more information. 

const (
	AccountSettingsDefaultNameserversCloudflareStandard AccountSettingsDefaultNameservers = "cloudflare.standard"
	AccountSettingsDefaultNameserversCustomAccount      AccountSettingsDefaultNameservers = "custom.account"
	AccountSettingsDefaultNameserversCustomTenant       AccountSettingsDefaultNameservers = "custom.tenant"
)

func (AccountSettingsDefaultNameservers) IsKnown 

func (r AccountSettingsDefaultNameservers) IsKnown() bool

type AccountUpdateParams 

type AccountUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Account name
	Name param.Field[string] `json:"name,required"`
	// Account settings
	Settings param.Field[AccountUpdateParamsSettings] `json:"settings"`
}

func (AccountUpdateParams) MarshalJSON 

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

type AccountUpdateParamsSettings 

type AccountUpdateParamsSettings struct {
	// Specifies the default nameservers to be used for new zones added to this
	// account.
	//
	// - `cloudflare.standard` for Cloudflare-branded nameservers
	// - `custom.account` for account custom nameservers
	// - `custom.tenant` for tenant custom nameservers
	//
	// See
	// [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)
	// for more information.
	DefaultNameservers param.Field[AccountUpdateParamsSettingsDefaultNameservers] `json:"default_nameservers"`
	// Indicates whether membership in this account requires that Two-Factor
	// Authentication is enabled
	EnforceTwofactor param.Field[bool] `json:"enforce_twofactor"`
	// Indicates whether new zones should use the account-level custom nameservers by
	// default.
	//
	// Deprecated in favor of `default_nameservers`.
	UseAccountCustomNSByDefault param.Field[bool] `json:"use_account_custom_ns_by_default"`
}

Account settings

func (AccountUpdateParamsSettings) MarshalJSON 

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

type AccountUpdateParamsSettingsDefaultNameservers 

type AccountUpdateParamsSettingsDefaultNameservers string

Specifies the default nameservers to be used for new zones added to this account.

- `cloudflare.standard` for Cloudflare-branded nameservers - `custom.account` for account custom nameservers - `custom.tenant` for tenant custom nameservers

See [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/) for more information. 

const (
	AccountUpdateParamsSettingsDefaultNameserversCloudflareStandard AccountUpdateParamsSettingsDefaultNameservers = "cloudflare.standard"
	AccountUpdateParamsSettingsDefaultNameserversCustomAccount      AccountUpdateParamsSettingsDefaultNameservers = "custom.account"
	AccountUpdateParamsSettingsDefaultNameserversCustomTenant       AccountUpdateParamsSettingsDefaultNameservers = "custom.tenant"
)

func (AccountUpdateParamsSettingsDefaultNameservers) IsKnown 

func (r AccountUpdateParamsSettingsDefaultNameservers) IsKnown() bool

type AccountUpdateResponse added in v2.3.0 

type AccountUpdateResponse interface {
	ImplementsAccountsAccountUpdateResponse()
}

Union satisfied by accounts.AccountUpdateResponseUnknown or shared.UnionString.

type AccountUpdateResponseEnvelope 

type AccountUpdateResponseEnvelope struct {
	Errors   []AccountUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccountUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccountUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accountUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccountUpdateResponseEnvelope) UnmarshalJSON 

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

type AccountUpdateResponseEnvelopeErrors 

type AccountUpdateResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    accountUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccountUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccountUpdateResponseEnvelopeMessages 

type AccountUpdateResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accountUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccountUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccountUpdateResponseEnvelopeSuccess 

type AccountUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccountUpdateResponseEnvelopeSuccessTrue AccountUpdateResponseEnvelopeSuccess = true
)

func (AccountUpdateResponseEnvelopeSuccess) IsKnown 

func (r AccountUpdateResponseEnvelopeSuccess) IsKnown() bool

type Error 

type Error = apierror.Error

type IamSchemasRole 

type IamSchemasRole struct {
	// Role identifier tag.
	ID string `json:"id,required"`
	// Description of role's permissions.
	Description string `json:"description,required"`
	// Role Name.
	Name string `json:"name,required"`
	// Access permissions for this User.
	Permissions []string           `json:"permissions,required"`
	JSON        iamSchemasRoleJSON `json:"-"`
}

func (*IamSchemasRole) UnmarshalJSON 

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

type MemberDeleteParams 

type MemberDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type MemberDeleteResponse 

type MemberDeleteResponse struct {
	// Identifier
	ID   string                   `json:"id,required"`
	JSON memberDeleteResponseJSON `json:"-"`
}

func (*MemberDeleteResponse) UnmarshalJSON 

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

type MemberDeleteResponseEnvelope 

type MemberDeleteResponseEnvelope struct {
	Errors   []MemberDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MemberDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   MemberDeleteResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success MemberDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    memberDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*MemberDeleteResponseEnvelope) UnmarshalJSON 

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

type MemberDeleteResponseEnvelopeErrors 

type MemberDeleteResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    memberDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MemberDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type MemberDeleteResponseEnvelopeMessages 

type MemberDeleteResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    memberDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MemberDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type MemberDeleteResponseEnvelopeSuccess 

type MemberDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	MemberDeleteResponseEnvelopeSuccessTrue MemberDeleteResponseEnvelopeSuccess = true
)

func (MemberDeleteResponseEnvelopeSuccess) IsKnown 

func (r MemberDeleteResponseEnvelopeSuccess) IsKnown() bool

type MemberGetParams 

type MemberGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type MemberGetResponseEnvelope 

type MemberGetResponseEnvelope struct {
	Errors   []MemberGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MemberGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountMember                       `json:"result,required"`
	// Whether the API call was successful
	Success MemberGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    memberGetResponseEnvelopeJSON    `json:"-"`
}

func (*MemberGetResponseEnvelope) UnmarshalJSON 

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

type MemberGetResponseEnvelopeErrors 

type MemberGetResponseEnvelopeErrors struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    memberGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MemberGetResponseEnvelopeErrors) UnmarshalJSON 

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

type MemberGetResponseEnvelopeMessages 

type MemberGetResponseEnvelopeMessages struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    memberGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MemberGetResponseEnvelopeMessages) UnmarshalJSON 

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

type MemberGetResponseEnvelopeSuccess 

type MemberGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	MemberGetResponseEnvelopeSuccessTrue MemberGetResponseEnvelopeSuccess = true
)

func (MemberGetResponseEnvelopeSuccess) IsKnown 

func (r MemberGetResponseEnvelopeSuccess) IsKnown() bool

type MemberListParams 

type MemberListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Direction to order results.
	Direction param.Field[MemberListParamsDirection] `query:"direction"`
	// Field to order results by.
	Order param.Field[MemberListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
	// A member's status in the account.
	Status param.Field[MemberListParamsStatus] `query:"status"`
}

func (MemberListParams) URLQuery 

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

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

type MemberListParamsDirection 

type MemberListParamsDirection string

Direction to order results. 

const (
	MemberListParamsDirectionAsc  MemberListParamsDirection = "asc"
	MemberListParamsDirectionDesc MemberListParamsDirection = "desc"
)

func (MemberListParamsDirection) IsKnown 

func (r MemberListParamsDirection) IsKnown() bool

type MemberListParamsOrder 

type MemberListParamsOrder string

Field to order results by. 

const (
	MemberListParamsOrderUserFirstName MemberListParamsOrder = "user.first_name"
	MemberListParamsOrderUserLastName  MemberListParamsOrder = "user.last_name"
	MemberListParamsOrderUserEmail     MemberListParamsOrder = "user.email"
	MemberListParamsOrderStatus        MemberListParamsOrder = "status"
)

func (MemberListParamsOrder) IsKnown 

func (r MemberListParamsOrder) IsKnown() bool

type MemberListParamsStatus 

type MemberListParamsStatus string

A member's status in the account. 

const (
	MemberListParamsStatusAccepted MemberListParamsStatus = "accepted"
	MemberListParamsStatusPending  MemberListParamsStatus = "pending"
	MemberListParamsStatusRejected MemberListParamsStatus = "rejected"
)

func (MemberListParamsStatus) IsKnown 

func (r MemberListParamsStatus) IsKnown() bool

type MemberListResponse 

type MemberListResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The contact email address of the user.
	Email string `json:"email,required"`
	// Member Name.
	Name string `json:"name,required,nullable"`
	// Roles assigned to this Member.
	Roles []IamSchemasRole `json:"roles,required"`
	// A member's status in the organization.
	Status MemberListResponseStatus `json:"status,required"`
	JSON   memberListResponseJSON   `json:"-"`
}

func (*MemberListResponse) UnmarshalJSON 

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

type MemberListResponseStatus 

type MemberListResponseStatus string

A member's status in the organization. 

const (
	MemberListResponseStatusAccepted MemberListResponseStatus = "accepted"
	MemberListResponseStatusInvited  MemberListResponseStatus = "invited"
)

func (MemberListResponseStatus) IsKnown 

func (r MemberListResponseStatus) IsKnown() bool

type MemberNewParams 

type MemberNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The contact email address of the user.
	Email param.Field[string] `json:"email,required"`
	// Array of roles associated with this member.
	Roles  param.Field[[]string]              `json:"roles,required"`
	Status param.Field[MemberNewParamsStatus] `json:"status"`
}

func (MemberNewParams) MarshalJSON 

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

type MemberNewParamsStatus 

type MemberNewParamsStatus string
const (
	MemberNewParamsStatusAccepted MemberNewParamsStatus = "accepted"
	MemberNewParamsStatusPending  MemberNewParamsStatus = "pending"
)

func (MemberNewParamsStatus) IsKnown 

func (r MemberNewParamsStatus) IsKnown() bool

type MemberNewResponseEnvelope 

type MemberNewResponseEnvelope struct {
	Errors   []MemberNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MemberNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountMemberWithID                 `json:"result,required"`
	// Whether the API call was successful
	Success MemberNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    memberNewResponseEnvelopeJSON    `json:"-"`
}

func (*MemberNewResponseEnvelope) UnmarshalJSON 

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

type MemberNewResponseEnvelopeErrors 

type MemberNewResponseEnvelopeErrors struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    memberNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MemberNewResponseEnvelopeErrors) UnmarshalJSON 

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

type MemberNewResponseEnvelopeMessages 

type MemberNewResponseEnvelopeMessages struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    memberNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MemberNewResponseEnvelopeMessages) UnmarshalJSON 

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

type MemberNewResponseEnvelopeSuccess 

type MemberNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	MemberNewResponseEnvelopeSuccessTrue MemberNewResponseEnvelopeSuccess = true
)

func (MemberNewResponseEnvelopeSuccess) IsKnown 

func (r MemberNewResponseEnvelopeSuccess) IsKnown() bool

type MemberService 

type MemberService struct {
	Options []option.RequestOption
}

MemberService 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 NewMemberService method instead.

func NewMemberService 

func NewMemberService(opts ...option.RequestOption) (r *MemberService)

NewMemberService 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 (*MemberService) Delete 

func (r *MemberService) Delete(ctx context.Context, memberID string, body MemberDeleteParams, opts ...option.RequestOption) (res *MemberDeleteResponse, err error)

Remove a member from an account.

func (*MemberService) Get 

func (r *MemberService) Get(ctx context.Context, memberID string, query MemberGetParams, opts ...option.RequestOption) (res *AccountMember, err error)

Get information about a specific member of an account.

func (*MemberService) List 

func (r *MemberService) List(ctx context.Context, params MemberListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[MemberListResponse], err error)

List all members of an account.

func (*MemberService) ListAutoPaging 

func (r *MemberService) ListAutoPaging(ctx context.Context, params MemberListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[MemberListResponse]

List all members of an account.

func (*MemberService) New 

func (r *MemberService) New(ctx context.Context, params MemberNewParams, opts ...option.RequestOption) (res *AccountMemberWithID, err error)

Add a user to the list of members for this account.

func (*MemberService) Update 

func (r *MemberService) Update(ctx context.Context, memberID string, params MemberUpdateParams, opts ...option.RequestOption) (res *AccountMember, err error)

Modify an account member.

type MemberUpdateParams 

type MemberUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Roles assigned to this member.
	Roles param.Field[[]MemberUpdateParamsRole] `json:"roles,required"`
}

func (MemberUpdateParams) MarshalJSON 

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

type MemberUpdateParamsRole 

type MemberUpdateParamsRole struct {
	// Role identifier tag.
	ID param.Field[string] `json:"id,required"`
}

func (MemberUpdateParamsRole) MarshalJSON 

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

type MemberUpdateParamsRolesPermissions 

type MemberUpdateParamsRolesPermissions struct {
	Analytics    param.Field[MemberUpdateParamsRolesPermissionsAnalytics]    `json:"analytics"`
	Billing      param.Field[MemberUpdateParamsRolesPermissionsBilling]      `json:"billing"`
	CachePurge   param.Field[MemberUpdateParamsRolesPermissionsCachePurge]   `json:"cache_purge"`
	DNS          param.Field[MemberUpdateParamsRolesPermissionsDNS]          `json:"dns"`
	DNSRecords   param.Field[MemberUpdateParamsRolesPermissionsDNSRecords]   `json:"dns_records"`
	Lb           param.Field[MemberUpdateParamsRolesPermissionsLb]           `json:"lb"`
	Logs         param.Field[MemberUpdateParamsRolesPermissionsLogs]         `json:"logs"`
	Organization param.Field[MemberUpdateParamsRolesPermissionsOrganization] `json:"organization"`
	SSL          param.Field[MemberUpdateParamsRolesPermissionsSSL]          `json:"ssl"`
	WAF          param.Field[MemberUpdateParamsRolesPermissionsWAF]          `json:"waf"`
	ZoneSettings param.Field[MemberUpdateParamsRolesPermissionsZoneSettings] `json:"zone_settings"`
	Zones        param.Field[MemberUpdateParamsRolesPermissionsZones]        `json:"zones"`
}

func (MemberUpdateParamsRolesPermissions) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsAnalytics 

type MemberUpdateParamsRolesPermissionsAnalytics struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsAnalytics) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsBilling 

type MemberUpdateParamsRolesPermissionsBilling struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsBilling) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsCachePurge 

type MemberUpdateParamsRolesPermissionsCachePurge struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsCachePurge) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsDNS 

type MemberUpdateParamsRolesPermissionsDNS struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsDNS) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsDNSRecords 

type MemberUpdateParamsRolesPermissionsDNSRecords struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsDNSRecords) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsLb 

type MemberUpdateParamsRolesPermissionsLb struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsLb) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsLogs 

type MemberUpdateParamsRolesPermissionsLogs struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsLogs) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsOrganization 

type MemberUpdateParamsRolesPermissionsOrganization struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsOrganization) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsSSL 

type MemberUpdateParamsRolesPermissionsSSL struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsSSL) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsWAF 

type MemberUpdateParamsRolesPermissionsWAF struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsWAF) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsZoneSettings 

type MemberUpdateParamsRolesPermissionsZoneSettings struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsZoneSettings) MarshalJSON 

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

type MemberUpdateParamsRolesPermissionsZones 

type MemberUpdateParamsRolesPermissionsZones struct {
	Read  param.Field[bool] `json:"read"`
	Write param.Field[bool] `json:"write"`
}

func (MemberUpdateParamsRolesPermissionsZones) MarshalJSON 

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

type MemberUpdateResponseEnvelope 

type MemberUpdateResponseEnvelope struct {
	Errors   []MemberUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MemberUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountMember                          `json:"result,required"`
	// Whether the API call was successful
	Success MemberUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    memberUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*MemberUpdateResponseEnvelope) UnmarshalJSON 

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

type MemberUpdateResponseEnvelopeErrors 

type MemberUpdateResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    memberUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MemberUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type MemberUpdateResponseEnvelopeMessages 

type MemberUpdateResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    memberUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MemberUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type MemberUpdateResponseEnvelopeSuccess 

type MemberUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	MemberUpdateResponseEnvelopeSuccessTrue MemberUpdateResponseEnvelopeSuccess = true
)

func (MemberUpdateResponseEnvelopeSuccess) IsKnown 

func (r MemberUpdateResponseEnvelopeSuccess) IsKnown() bool

type RoleGetParams 

type RoleGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type RoleGetResponse added in v2.3.0 

type RoleGetResponse interface {
	ImplementsAccountsRoleGetResponse()
}

Union satisfied by accounts.RoleGetResponseUnknown or shared.UnionString.

type RoleGetResponseEnvelope 

type RoleGetResponseEnvelope struct {
	Errors   []RoleGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoleGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RoleGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoleGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    roleGetResponseEnvelopeJSON    `json:"-"`
}

func (*RoleGetResponseEnvelope) UnmarshalJSON 

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

type RoleGetResponseEnvelopeErrors 

type RoleGetResponseEnvelopeErrors struct {
	Code    int64                             `json:"code,required"`
	Message string                            `json:"message,required"`
	JSON    roleGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoleGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoleGetResponseEnvelopeMessages 

type RoleGetResponseEnvelopeMessages struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    roleGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoleGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoleGetResponseEnvelopeSuccess 

type RoleGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoleGetResponseEnvelopeSuccessTrue RoleGetResponseEnvelopeSuccess = true
)

func (RoleGetResponseEnvelopeSuccess) IsKnown 

func (r RoleGetResponseEnvelopeSuccess) IsKnown() bool

type RoleListParams 

type RoleListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type RoleListResponseEnvelope 

type RoleListResponseEnvelope struct {
	Errors   []RoleListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoleListResponseEnvelopeMessages `json:"messages,required"`
	Result   []IamSchemasRole                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    RoleListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo RoleListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       roleListResponseEnvelopeJSON       `json:"-"`
}

func (*RoleListResponseEnvelope) UnmarshalJSON 

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

type RoleListResponseEnvelopeErrors 

type RoleListResponseEnvelopeErrors struct {
	Code    int64                              `json:"code,required"`
	Message string                             `json:"message,required"`
	JSON    roleListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoleListResponseEnvelopeErrors) UnmarshalJSON 

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

type RoleListResponseEnvelopeMessages 

type RoleListResponseEnvelopeMessages struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    roleListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoleListResponseEnvelopeMessages) UnmarshalJSON 

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

type RoleListResponseEnvelopeResultInfo 

type RoleListResponseEnvelopeResultInfo 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       roleListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*RoleListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type RoleListResponseEnvelopeSuccess 

type RoleListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoleListResponseEnvelopeSuccessTrue RoleListResponseEnvelopeSuccess = true
)

func (RoleListResponseEnvelopeSuccess) IsKnown 

func (r RoleListResponseEnvelopeSuccess) IsKnown() bool

type RoleService 

type RoleService struct {
	Options []option.RequestOption
}

RoleService 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 NewRoleService method instead.

func NewRoleService 

func NewRoleService(opts ...option.RequestOption) (r *RoleService)

NewRoleService 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 (*RoleService) Get 

func (r *RoleService) Get(ctx context.Context, roleID interface{}, query RoleGetParams, opts ...option.RequestOption) (res *RoleGetResponse, err error)

Get information about a specific role for an account.

func (*RoleService) List 

func (r *RoleService) List(ctx context.Context, query RoleListParams, opts ...option.RequestOption) (res *[]IamSchemasRole, err error)

Get all available roles for an account.

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.