Documentation
¶
Index ¶
- type CallDeleteParams
- type CallDeleteResponseEnvelope
- type CallDeleteResponseEnvelopeErrors
- type CallDeleteResponseEnvelopeMessages
- type CallDeleteResponseEnvelopeSuccess
- type CallGetParams
- type CallGetResponseEnvelope
- type CallGetResponseEnvelopeErrors
- type CallGetResponseEnvelopeMessages
- type CallGetResponseEnvelopeSuccess
- type CallListParams
- type CallListResponseEnvelope
- type CallListResponseEnvelopeErrors
- type CallListResponseEnvelopeMessages
- type CallListResponseEnvelopeSuccess
- type CallNewParams
- type CallNewResponseEnvelope
- type CallNewResponseEnvelopeErrors
- type CallNewResponseEnvelopeMessages
- type CallNewResponseEnvelopeSuccess
- type CallService
- func (r *CallService) Delete(ctx context.Context, appID string, body CallDeleteParams, ...) (res *CallsApp, err error)
- func (r *CallService) Get(ctx context.Context, appID string, query CallGetParams, ...) (res *CallsApp, err error)
- func (r *CallService) List(ctx context.Context, query CallListParams, opts ...option.RequestOption) (res *[]CallsApp, err error)
- func (r *CallService) New(ctx context.Context, params CallNewParams, opts ...option.RequestOption) (res *CallsAppWithSecret, err error)
- func (r *CallService) Update(ctx context.Context, appID string, params CallUpdateParams, ...) (res *CallsApp, err error)
- type CallUpdateParams
- type CallUpdateResponseEnvelope
- type CallUpdateResponseEnvelopeErrors
- type CallUpdateResponseEnvelopeMessages
- type CallUpdateResponseEnvelopeSuccess
- type CallsApp
- type CallsAppWithSecret
- type Error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CallDeleteParams ¶
type CallDeleteResponseEnvelope ¶
type CallDeleteResponseEnvelope struct {
Errors []CallDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []CallDeleteResponseEnvelopeMessages `json:"messages,required"`
Result CallsApp `json:"result,required"`
// Whether the API call was successful
Success CallDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON callDeleteResponseEnvelopeJSON `json:"-"`
}
func (*CallDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *CallDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallDeleteResponseEnvelopeErrors ¶
type CallDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CallDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CallDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CallDeleteResponseEnvelopeMessages ¶
type CallDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CallDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CallDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CallDeleteResponseEnvelopeSuccess ¶
type CallDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallDeleteResponseEnvelopeSuccessTrue CallDeleteResponseEnvelopeSuccess = true
)
type CallGetParams ¶
type CallGetResponseEnvelope ¶
type CallGetResponseEnvelope struct {
Errors []CallGetResponseEnvelopeErrors `json:"errors,required"`
Messages []CallGetResponseEnvelopeMessages `json:"messages,required"`
Result CallsApp `json:"result,required"`
// Whether the API call was successful
Success CallGetResponseEnvelopeSuccess `json:"success,required"`
JSON callGetResponseEnvelopeJSON `json:"-"`
}
func (*CallGetResponseEnvelope) UnmarshalJSON ¶
func (r *CallGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallGetResponseEnvelopeErrors ¶
type CallGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CallGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CallGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CallGetResponseEnvelopeMessages ¶
type CallGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CallGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CallGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CallGetResponseEnvelopeSuccess ¶
type CallGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallGetResponseEnvelopeSuccessTrue CallGetResponseEnvelopeSuccess = true
)
type CallListParams ¶
type CallListResponseEnvelope ¶
type CallListResponseEnvelope struct {
Errors []CallListResponseEnvelopeErrors `json:"errors,required"`
Messages []CallListResponseEnvelopeMessages `json:"messages,required"`
Result []CallsApp `json:"result,required"`
// Whether the API call was successful
Success CallListResponseEnvelopeSuccess `json:"success,required"`
JSON callListResponseEnvelopeJSON `json:"-"`
}
func (*CallListResponseEnvelope) UnmarshalJSON ¶
func (r *CallListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallListResponseEnvelopeErrors ¶
type CallListResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CallListResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CallListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CallListResponseEnvelopeMessages ¶
type CallListResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CallListResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CallListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CallListResponseEnvelopeSuccess ¶
type CallListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallListResponseEnvelopeSuccessTrue CallListResponseEnvelopeSuccess = true
)
type CallNewParams ¶
type CallNewParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// A short description of Calls app, not shown to end users.
Name param.Field[string] `json:"name"`
}
func (CallNewParams) MarshalJSON ¶
func (r CallNewParams) MarshalJSON() (data []byte, err error)
type CallNewResponseEnvelope ¶
type CallNewResponseEnvelope struct {
Errors []CallNewResponseEnvelopeErrors `json:"errors,required"`
Messages []CallNewResponseEnvelopeMessages `json:"messages,required"`
Result CallsAppWithSecret `json:"result,required"`
// Whether the API call was successful
Success CallNewResponseEnvelopeSuccess `json:"success,required"`
JSON callNewResponseEnvelopeJSON `json:"-"`
}
func (*CallNewResponseEnvelope) UnmarshalJSON ¶
func (r *CallNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallNewResponseEnvelopeErrors ¶
type CallNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CallNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CallNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CallNewResponseEnvelopeMessages ¶
type CallNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CallNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CallNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CallNewResponseEnvelopeSuccess ¶
type CallNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallNewResponseEnvelopeSuccessTrue CallNewResponseEnvelopeSuccess = true
)
type CallService ¶
type CallService struct {
Options []option.RequestOption
}
CallService 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 NewCallService method instead.
func NewCallService ¶
func NewCallService(opts ...option.RequestOption) (r *CallService)
NewCallService 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 (*CallService) Delete ¶
func (r *CallService) Delete(ctx context.Context, appID string, body CallDeleteParams, opts ...option.RequestOption) (res *CallsApp, err error)
Deletes an app from Cloudflare Calls
func (*CallService) Get ¶
func (r *CallService) Get(ctx context.Context, appID string, query CallGetParams, opts ...option.RequestOption) (res *CallsApp, err error)
Fetches details for a single Calls app.
func (*CallService) List ¶
func (r *CallService) List(ctx context.Context, query CallListParams, opts ...option.RequestOption) (res *[]CallsApp, err error)
Lists all apps in the Cloudflare account
func (*CallService) New ¶
func (r *CallService) New(ctx context.Context, params CallNewParams, opts ...option.RequestOption) (res *CallsAppWithSecret, err error)
Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.
func (*CallService) Update ¶
func (r *CallService) Update(ctx context.Context, appID string, params CallUpdateParams, opts ...option.RequestOption) (res *CallsApp, err error)
Edit details for a single app.
type CallUpdateParams ¶
type CallUpdateParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// A short description of Calls app, not shown to end users.
Name param.Field[string] `json:"name"`
}
func (CallUpdateParams) MarshalJSON ¶
func (r CallUpdateParams) MarshalJSON() (data []byte, err error)
type CallUpdateResponseEnvelope ¶
type CallUpdateResponseEnvelope struct {
Errors []CallUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []CallUpdateResponseEnvelopeMessages `json:"messages,required"`
Result CallsApp `json:"result,required"`
// Whether the API call was successful
Success CallUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON callUpdateResponseEnvelopeJSON `json:"-"`
}
func (*CallUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CallUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallUpdateResponseEnvelopeErrors ¶
type CallUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CallUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CallUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CallUpdateResponseEnvelopeMessages ¶
type CallUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON callUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CallUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CallUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CallUpdateResponseEnvelopeSuccess ¶
type CallUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallUpdateResponseEnvelopeSuccessTrue CallUpdateResponseEnvelopeSuccess = true
)
type CallsApp ¶
type CallsApp struct {
// The date and time the item was created.
Created time.Time `json:"created" format:"date-time"`
// The date and time the item was last modified.
Modified time.Time `json:"modified" format:"date-time"`
// A short description of Calls app, not shown to end users.
Name string `json:"name"`
// A Cloudflare-generated unique identifier for a item.
Uid string `json:"uid"`
JSON callsAppJSON `json:"-"`
}
func (*CallsApp) UnmarshalJSON ¶
type CallsAppWithSecret ¶
type CallsAppWithSecret struct {
// The date and time the item was created.
Created time.Time `json:"created" format:"date-time"`
// The date and time the item was last modified.
Modified time.Time `json:"modified" format:"date-time"`
// A short description of Calls app, not shown to end users.
Name string `json:"name"`
// Bearer token to use the Calls API.
Secret string `json:"secret"`
// A Cloudflare-generated unique identifier for a item.
Uid string `json:"uid"`
JSON callsAppWithSecretJSON `json:"-"`
}
func (*CallsAppWithSecret) UnmarshalJSON ¶
func (r *CallsAppWithSecret) UnmarshalJSON(data []byte) (err error)