casemanagementv1

package
v0.72.0 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2024 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Overview

Package casemanagementv1 : Operations and models for the CaseManagementV1 service

Index

Constants

View Source 
const (
	CaseContactTypeCloudSupportCenterConst = "Cloud Support Center"
	CaseContactTypeImsConsoleConst         = "IMS Console"
)

Constants associated with the Case.ContactType property. Name of the console to interact with the contact.

View Source 
const (
	CaseSupportTierBasicConst    = "Basic"
	CaseSupportTierFreeConst     = "Free"
	CaseSupportTierPremiumConst  = "Premium"
	CaseSupportTierStandardConst = "Standard"
)

Constants associated with the Case.SupportTier property. Support tier of the account.

View Source 
const (
	CreateCaseOptionsTypeAccountAndAccessConst  = "account_and_access"
	CreateCaseOptionsTypeBillingAndInvoiceConst = "billing_and_invoice"
	CreateCaseOptionsTypeSalesConst             = "sales"
	CreateCaseOptionsTypeTechnicalConst         = "technical"
)

Constants associated with the CreateCaseOptions.Type property. Case type.

View Source 
const (
	GetCaseOptionsFieldsAgentCloseOnlyConst   = "agent_close_only"
	GetCaseOptionsFieldsAttachmentsConst      = "attachments"
	GetCaseOptionsFieldsCloseNotesConst       = "close_notes"
	GetCaseOptionsFieldsCommentsConst         = "comments"
	GetCaseOptionsFieldsContactConst          = "contact"
	GetCaseOptionsFieldsContactTypeConst      = "contact_type"
	GetCaseOptionsFieldsCreatedAtConst        = "created_at"
	GetCaseOptionsFieldsCreatedByConst        = "created_by"
	GetCaseOptionsFieldsDescriptionConst      = "description"
	GetCaseOptionsFieldsEuConst               = "eu"
	GetCaseOptionsFieldsInvoiceNumberConst    = "invoice_number"
	GetCaseOptionsFieldsNumberConst           = "number"
	GetCaseOptionsFieldsOfferingConst         = "offering"
	GetCaseOptionsFieldsResolutionConst       = "resolution"
	GetCaseOptionsFieldsResourcesConst        = "resources"
	GetCaseOptionsFieldsSeverityConst         = "severity"
	GetCaseOptionsFieldsShortDescriptionConst = "short_description"
	GetCaseOptionsFieldsStatusConst           = "status"
	GetCaseOptionsFieldsSupportTierConst      = "support_tier"
	GetCaseOptionsFieldsUpdatedAtConst        = "updated_at"
	GetCaseOptionsFieldsUpdatedByConst        = "updated_by"
	GetCaseOptionsFieldsWatchlistConst        = "watchlist"
)

Constants associated with the GetCaseOptions.Fields property.

View Source 
const (
	GetCasesOptionsStatusClosedConst             = "closed"
	GetCasesOptionsStatusInProgressConst         = "in_progress"
	GetCasesOptionsStatusNewConst                = "new"
	GetCasesOptionsStatusResolutionProvidedConst = "resolution_provided"
	GetCasesOptionsStatusResolvedConst           = "resolved"
	GetCasesOptionsStatusWaitingOnClientConst    = "waiting_on_client"
)

Constants associated with the GetCasesOptions.Status property.

View Source 
const (
	GetCasesOptionsFieldsAgentCloseOnlyConst   = "agent_close_only"
	GetCasesOptionsFieldsAttachmentsConst      = "attachments"
	GetCasesOptionsFieldsCloseNotesConst       = "close_notes"
	GetCasesOptionsFieldsCommentsConst         = "comments"
	GetCasesOptionsFieldsContactConst          = "contact"
	GetCasesOptionsFieldsContactTypeConst      = "contact_type"
	GetCasesOptionsFieldsCreatedAtConst        = "created_at"
	GetCasesOptionsFieldsCreatedByConst        = "created_by"
	GetCasesOptionsFieldsDescriptionConst      = "description"
	GetCasesOptionsFieldsEuConst               = "eu"
	GetCasesOptionsFieldsInvoiceNumberConst    = "invoice_number"
	GetCasesOptionsFieldsNumberConst           = "number"
	GetCasesOptionsFieldsOfferingConst         = "offering"
	GetCasesOptionsFieldsResolutionConst       = "resolution"
	GetCasesOptionsFieldsResourcesConst        = "resources"
	GetCasesOptionsFieldsSeverityConst         = "severity"
	GetCasesOptionsFieldsShortDescriptionConst = "short_description"
	GetCasesOptionsFieldsStatusConst           = "status"
	GetCasesOptionsFieldsSupportTierConst      = "support_tier"
	GetCasesOptionsFieldsUpdatedAtConst        = "updated_at"
	GetCasesOptionsFieldsUpdatedByConst        = "updated_by"
	GetCasesOptionsFieldsWatchlistConst        = "watchlist"
)

Constants associated with the GetCasesOptions.Fields property.

View Source 
const (
	OfferingTypeGroupCRNServiceNameConst = "crn_service_name"
	OfferingTypeGroupCategoryConst       = "category"
)

Constants associated with the OfferingType.Group property. Offering type group. "crn_service_name" is preferred over "category" as the latter is legacy and will be deprecated in the future.

View Source 
const (
	StatusPayloadActionAcceptConst    = "accept"
	StatusPayloadActionResolveConst   = "resolve"
	StatusPayloadActionUnresolveConst = "unresolve"
)

Constants associated with the StatusPayload.Action property. action to perform on the case.

View Source 
const (
	UserRealmBssConst   = "BSS"
	UserRealmIbmidConst = "IBMid"
	UserRealmSlConst    = "SL"
)

Constants associated with the User.Realm property. the ID realm.

View Source 
const (
	AcceptPayloadActionAcceptConst    = "accept"
	AcceptPayloadActionResolveConst   = "resolve"
	AcceptPayloadActionUnresolveConst = "unresolve"
)

Constants associated with the AcceptPayload.Action property. action to perform on the case.

View Source 
const (
	ResolvePayloadActionAcceptConst    = "accept"
	ResolvePayloadActionResolveConst   = "resolve"
	ResolvePayloadActionUnresolveConst = "unresolve"
)

Constants associated with the ResolvePayload.Action property. action to perform on the case.

View Source 
const (
	UnresolvePayloadActionAcceptConst    = "accept"
	UnresolvePayloadActionResolveConst   = "resolve"
	UnresolvePayloadActionUnresolveConst = "unresolve"
)

Constants associated with the UnresolvePayload.Action property. action to perform on the case.

View Source 
const DefaultServiceName = "case_management"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://support-center.cloud.ibm.com/case-management/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.17.1 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAcceptPayload 

func UnmarshalAcceptPayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAcceptPayload unmarshals an instance of AcceptPayload from the specified map of raw messages.

func UnmarshalAttachment 

func UnmarshalAttachment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAttachment unmarshals an instance of Attachment from the specified map of raw messages.

func UnmarshalAttachmentList 

func UnmarshalAttachmentList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAttachmentList unmarshals an instance of AttachmentList from the specified map of raw messages.

func UnmarshalCase 

func UnmarshalCase(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCase unmarshals an instance of Case from the specified map of raw messages.

func UnmarshalCaseEu 

func UnmarshalCaseEu(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCaseEu unmarshals an instance of CaseEu from the specified map of raw messages.

func UnmarshalCaseList 

func UnmarshalCaseList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCaseList unmarshals an instance of CaseList from the specified map of raw messages.

func UnmarshalCasePayloadEu 

func UnmarshalCasePayloadEu(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCasePayloadEu unmarshals an instance of CasePayloadEu from the specified map of raw messages.

func UnmarshalComment 

func UnmarshalComment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalComment unmarshals an instance of Comment from the specified map of raw messages.

func UnmarshalFileWithMetadata 

func UnmarshalFileWithMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFileWithMetadata unmarshals an instance of FileWithMetadata from the specified map of raw messages.

func UnmarshalOffering 

func UnmarshalOffering(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOffering unmarshals an instance of Offering from the specified map of raw messages.

func UnmarshalOfferingType 

func UnmarshalOfferingType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOfferingType unmarshals an instance of OfferingType from the specified map of raw messages. 

func UnmarshalPaginationLink(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPaginationLink unmarshals an instance of PaginationLink from the specified map of raw messages.

func UnmarshalResolvePayload 

func UnmarshalResolvePayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResolvePayload unmarshals an instance of ResolvePayload from the specified map of raw messages.

func UnmarshalResource 

func UnmarshalResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResource unmarshals an instance of Resource from the specified map of raw messages.

func UnmarshalResourcePayload 

func UnmarshalResourcePayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourcePayload unmarshals an instance of ResourcePayload from the specified map of raw messages.

func UnmarshalStatusPayload 

func UnmarshalStatusPayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalStatusPayload unmarshals an instance of StatusPayload from the specified map of raw messages.

func UnmarshalUnresolvePayload 

func UnmarshalUnresolvePayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUnresolvePayload unmarshals an instance of UnresolvePayload from the specified map of raw messages.

func UnmarshalUser 

func UnmarshalUser(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUser unmarshals an instance of User from the specified map of raw messages.

func UnmarshalWatchlist 

func UnmarshalWatchlist(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWatchlist unmarshals an instance of Watchlist from the specified map of raw messages.

func UnmarshalWatchlistAddResponse 

func UnmarshalWatchlistAddResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWatchlistAddResponse unmarshals an instance of WatchlistAddResponse from the specified map of raw messages.

Types

type AcceptPayload 

type AcceptPayload struct {
	// action to perform on the case.
	Action *string `json:"action" validate:"required"`

	// Comment about accepting the proposed resolution.
	Comment *string `json:"comment,omitempty"`
}

AcceptPayload : Payload to accept the proposed resolution of the case. This model "extends" StatusPayload

type AddCommentOptions 

type AddCommentOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Comment to add to the case.
	Comment *string `json:"comment" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddCommentOptions : The AddComment options.

func (*AddCommentOptions) SetCaseNumber 

func (_options *AddCommentOptions) SetCaseNumber(caseNumber string) *AddCommentOptions

SetCaseNumber : Allow user to set CaseNumber

func (*AddCommentOptions) SetComment 

func (_options *AddCommentOptions) SetComment(comment string) *AddCommentOptions

SetComment : Allow user to set Comment

func (*AddCommentOptions) SetHeaders 

func (options *AddCommentOptions) SetHeaders(param map[string]string) *AddCommentOptions

SetHeaders : Allow user to set Headers

type AddResourceOptions 

type AddResourceOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Cloud Resource Name of the resource.
	CRN *string `json:"crn,omitempty"`

	// Only used to attach Classic IaaS devices that have no CRN.
	Type *string `json:"type,omitempty"`

	// Only used to attach Classic IaaS devices that have no CRN. Id of Classic IaaS device. This is deprecated in favor of
	// the crn field.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ID *float64 `json:"id,omitempty"`

	// A note about this resource.
	Note *string `json:"note,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddResourceOptions : The AddResource options.

func (*AddResourceOptions) SetCRN added in v0.17.1 

func (_options *AddResourceOptions) SetCRN(crn string) *AddResourceOptions

SetCRN : Allow user to set CRN

func (*AddResourceOptions) SetCaseNumber 

func (_options *AddResourceOptions) SetCaseNumber(caseNumber string) *AddResourceOptions

SetCaseNumber : Allow user to set CaseNumber

func (*AddResourceOptions) SetHeaders 

func (options *AddResourceOptions) SetHeaders(param map[string]string) *AddResourceOptions

SetHeaders : Allow user to set Headers

func (*AddResourceOptions) SetID 

func (_options *AddResourceOptions) SetID(id float64) *AddResourceOptions

SetID : Allow user to set ID Deprecated: this method is deprecated and may be removed in a future release.

func (*AddResourceOptions) SetNote 

func (_options *AddResourceOptions) SetNote(note string) *AddResourceOptions

SetNote : Allow user to set Note

func (*AddResourceOptions) SetType 

func (_options *AddResourceOptions) SetType(typeVar string) *AddResourceOptions

SetType : Allow user to set Type

type AddWatchlistOptions 

type AddWatchlistOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Array of user ID objects.
	Watchlist []User `json:"watchlist,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddWatchlistOptions : The AddWatchlist options.

func (*AddWatchlistOptions) SetCaseNumber 

func (_options *AddWatchlistOptions) SetCaseNumber(caseNumber string) *AddWatchlistOptions

SetCaseNumber : Allow user to set CaseNumber

func (*AddWatchlistOptions) SetHeaders 

func (options *AddWatchlistOptions) SetHeaders(param map[string]string) *AddWatchlistOptions

SetHeaders : Allow user to set Headers

func (*AddWatchlistOptions) SetWatchlist 

func (_options *AddWatchlistOptions) SetWatchlist(watchlist []User) *AddWatchlistOptions

SetWatchlist : Allow user to set Watchlist

type Attachment 

type Attachment struct {
	// Unique identifier of the attachment in database.
	ID *string `json:"id,omitempty"`

	// Name of the attachment.
	Filename *string `json:"filename,omitempty"`

	// Size of the attachment in bytes.
	SizeInBytes *int64 `json:"size_in_bytes,omitempty"`

	// Date time of uploading in UTC.
	CreatedAt *string `json:"created_at,omitempty"`

	// URL of the attachment used to download.
	URL *string `json:"url,omitempty"`
}

Attachment : Details of an attachment.

type AttachmentList 

type AttachmentList struct {
	// New attachments array.
	Attachments []Attachment `json:"attachments,omitempty"`
}

AttachmentList : List of attachments in the case.

type Case 

type Case struct {
	// Identifying number of a created case.
	Number *string `json:"number,omitempty"`

	// Short description of what the case is about.
	ShortDescription *string `json:"short_description,omitempty"`

	// Full description of what the case is about.
	Description *string `json:"description,omitempty"`

	// Date and time of case creation in UTC.
	CreatedAt *string `json:"created_at,omitempty"`

	// User info in a case.
	CreatedBy *User `json:"created_by,omitempty"`

	// Date and time of the last update on the case in UTC.
	UpdatedAt *string `json:"updated_at,omitempty"`

	// User info in a case.
	UpdatedBy *User `json:"updated_by,omitempty"`

	// Name of the console to interact with the contact.
	ContactType *string `json:"contact_type,omitempty"`

	// User info in a case.
	Contact *User `json:"contact,omitempty"`

	// Status type of the case.
	Status *string `json:"status,omitempty"`

	// Severity level of the case.
	Severity *float64 `json:"severity,omitempty"`

	// Support tier of the account.
	SupportTier *string `json:"support_tier,omitempty"`

	// Standard reasons of resolving case.
	Resolution *string `json:"resolution,omitempty"`

	// Notes of case closing.
	CloseNotes *string `json:"close_notes,omitempty"`

	// EU support.
	Eu *CaseEu `json:"eu,omitempty"`

	// List of users in the case watchlist.
	Watchlist []User `json:"watchlist,omitempty"`

	// List of files that are attached to the case.
	Attachments []Attachment `json:"attachments,omitempty"`

	// Offering details.
	Offering *Offering `json:"offering,omitempty"`

	// List of attached resources.
	Resources []Resource `json:"resources,omitempty"`

	// List of comments and updates that are sorted in chronological order.
	Comments []Comment `json:"comments,omitempty"`
}

Case : The support case.

type CaseEu 

type CaseEu struct {
	// Identifying whether the case has EU Support.
	Support *bool `json:"support,omitempty"`

	// Information about the data center.
	DataCenter *string `json:"data_center,omitempty"`
}

CaseEu : EU support.

type CaseList 

type CaseList struct {
	// Total number of cases that satisfy the query.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Container for URL pointer to related pages of cases.
	First *PaginationLink `json:"first,omitempty"`

	// Container for URL pointer to related pages of cases.
	Next *PaginationLink `json:"next,omitempty"`

	// Container for URL pointer to related pages of cases.
	Previous *PaginationLink `json:"previous,omitempty"`

	// Container for URL pointer to related pages of cases.
	Last *PaginationLink `json:"last,omitempty"`

	// List of cases.
	Cases []Case `json:"cases,omitempty"`
}

CaseList : Response of a GET /cases request.

func (*CaseList) GetNextOffset added in v0.28.7 

func (resp *CaseList) GetNextOffset() (*int64, error)

Retrieve the value to be passed to a request to access the next page of results

type CaseManagementV1 

type CaseManagementV1 struct {
	Service *core.BaseService
}

CaseManagementV1 : Case management API for creating cases, getting case statuses, adding comments to a case, adding and removing users from a case watchlist, downloading and adding attachments, and more.

API Version: 1.0.0

func NewCaseManagementV1 

func NewCaseManagementV1(options *CaseManagementV1Options) (service *CaseManagementV1, err error)

NewCaseManagementV1 : constructs an instance of CaseManagementV1 with passed in options.

func NewCaseManagementV1UsingExternalConfig 

func NewCaseManagementV1UsingExternalConfig(options *CaseManagementV1Options) (caseManagement *CaseManagementV1, err error)

NewCaseManagementV1UsingExternalConfig : constructs an instance of CaseManagementV1 with passed in options and external configuration.

func (*CaseManagementV1) AddComment 

func (caseManagement *CaseManagementV1) AddComment(addCommentOptions *AddCommentOptions) (result *Comment, response *core.DetailedResponse, err error)

AddComment : Add comment to case Add a comment to a case to be viewed by a support engineer.

func (*CaseManagementV1) AddCommentWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) AddCommentWithContext(ctx context.Context, addCommentOptions *AddCommentOptions) (result *Comment, response *core.DetailedResponse, err error)

AddCommentWithContext is an alternate form of the AddComment method which supports a Context parameter

func (*CaseManagementV1) AddResource 

func (caseManagement *CaseManagementV1) AddResource(addResourceOptions *AddResourceOptions) (result *Resource, response *core.DetailedResponse, err error)

AddResource : Add a resource to case Add a resource to case by specifying the Cloud Resource Name (CRN), or id and type if attaching a class iaaS resource.

func (*CaseManagementV1) AddResourceWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) AddResourceWithContext(ctx context.Context, addResourceOptions *AddResourceOptions) (result *Resource, response *core.DetailedResponse, err error)

AddResourceWithContext is an alternate form of the AddResource method which supports a Context parameter

func (*CaseManagementV1) AddWatchlist 

func (caseManagement *CaseManagementV1) AddWatchlist(addWatchlistOptions *AddWatchlistOptions) (result *WatchlistAddResponse, response *core.DetailedResponse, err error)

AddWatchlist : Add users to watchlist of case Add users to the watchlist of case. By adding a user to the watchlist of the case, you are granting them read and write permissions, so the user can view the case, receive updates, and make updates to the case. Note that the user must be in the account to be added to the watchlist.

func (*CaseManagementV1) AddWatchlistWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) AddWatchlistWithContext(ctx context.Context, addWatchlistOptions *AddWatchlistOptions) (result *WatchlistAddResponse, response *core.DetailedResponse, err error)

AddWatchlistWithContext is an alternate form of the AddWatchlist method which supports a Context parameter

func (*CaseManagementV1) Clone added in v0.17.1 

func (caseManagement *CaseManagementV1) Clone() *CaseManagementV1

Clone makes a copy of "caseManagement" suitable for processing requests.

func (*CaseManagementV1) CreateCase 

func (caseManagement *CaseManagementV1) CreateCase(createCaseOptions *CreateCaseOptions) (result *Case, response *core.DetailedResponse, err error)

CreateCase : Create a case Create a support case to resolve issues in your account.

func (*CaseManagementV1) CreateCaseWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) CreateCaseWithContext(ctx context.Context, createCaseOptions *CreateCaseOptions) (result *Case, response *core.DetailedResponse, err error)

CreateCaseWithContext is an alternate form of the CreateCase method which supports a Context parameter

func (*CaseManagementV1) DeleteFile 

func (caseManagement *CaseManagementV1) DeleteFile(deleteFileOptions *DeleteFileOptions) (result *AttachmentList, response *core.DetailedResponse, err error)

DeleteFile : Remove attachment from case Remove an attachment from a case.

func (*CaseManagementV1) DeleteFileWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) DeleteFileWithContext(ctx context.Context, deleteFileOptions *DeleteFileOptions) (result *AttachmentList, response *core.DetailedResponse, err error)

DeleteFileWithContext is an alternate form of the DeleteFile method which supports a Context parameter

func (*CaseManagementV1) DisableRetries added in v0.12.2 

func (caseManagement *CaseManagementV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*CaseManagementV1) DownloadFile 

func (caseManagement *CaseManagementV1) DownloadFile(downloadFileOptions *DownloadFileOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

DownloadFile : Download an attachment Download an attachment from a case.

func (*CaseManagementV1) DownloadFileWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) DownloadFileWithContext(ctx context.Context, downloadFileOptions *DownloadFileOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

DownloadFileWithContext is an alternate form of the DownloadFile method which supports a Context parameter

func (*CaseManagementV1) EnableRetries added in v0.12.2 

func (caseManagement *CaseManagementV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*CaseManagementV1) GetCase 

func (caseManagement *CaseManagementV1) GetCase(getCaseOptions *GetCaseOptions) (result *Case, response *core.DetailedResponse, err error)

GetCase : Get a case in account View a case in the account that is specified by the case number.

func (*CaseManagementV1) GetCaseWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) GetCaseWithContext(ctx context.Context, getCaseOptions *GetCaseOptions) (result *Case, response *core.DetailedResponse, err error)

GetCaseWithContext is an alternate form of the GetCase method which supports a Context parameter

func (*CaseManagementV1) GetCases 

func (caseManagement *CaseManagementV1) GetCases(getCasesOptions *GetCasesOptions) (result *CaseList, response *core.DetailedResponse, err error)

GetCases : Get cases in account Get cases in the account that are specified by the content of the IAM token.

func (*CaseManagementV1) GetCasesWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) GetCasesWithContext(ctx context.Context, getCasesOptions *GetCasesOptions) (result *CaseList, response *core.DetailedResponse, err error)

GetCasesWithContext is an alternate form of the GetCases method which supports a Context parameter

func (*CaseManagementV1) GetEnableGzipCompression added in v0.12.2 

func (caseManagement *CaseManagementV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*CaseManagementV1) GetServiceURL added in v0.12.2 

func (caseManagement *CaseManagementV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*CaseManagementV1) NewAcceptPayload 

func (*CaseManagementV1) NewAcceptPayload(action string) (_model *AcceptPayload, err error)

NewAcceptPayload : Instantiate AcceptPayload (Generic Model Constructor)

func (*CaseManagementV1) NewAddCommentOptions 

func (*CaseManagementV1) NewAddCommentOptions(caseNumber string, comment string) *AddCommentOptions

NewAddCommentOptions : Instantiate AddCommentOptions

func (*CaseManagementV1) NewAddResourceOptions 

func (*CaseManagementV1) NewAddResourceOptions(caseNumber string) *AddResourceOptions

NewAddResourceOptions : Instantiate AddResourceOptions

func (*CaseManagementV1) NewAddWatchlistOptions 

func (*CaseManagementV1) NewAddWatchlistOptions(caseNumber string) *AddWatchlistOptions

NewAddWatchlistOptions : Instantiate AddWatchlistOptions

func (*CaseManagementV1) NewCreateCaseOptions 

func (*CaseManagementV1) NewCreateCaseOptions(typeVar string, subject string, description string) *CreateCaseOptions

NewCreateCaseOptions : Instantiate CreateCaseOptions

func (*CaseManagementV1) NewDeleteFileOptions 

func (*CaseManagementV1) NewDeleteFileOptions(caseNumber string, fileID string) *DeleteFileOptions

NewDeleteFileOptions : Instantiate DeleteFileOptions

func (*CaseManagementV1) NewDownloadFileOptions 

func (*CaseManagementV1) NewDownloadFileOptions(caseNumber string, fileID string) *DownloadFileOptions

NewDownloadFileOptions : Instantiate DownloadFileOptions

func (*CaseManagementV1) NewFileWithMetadata 

func (*CaseManagementV1) NewFileWithMetadata(data io.ReadCloser) (_model *FileWithMetadata, err error)

NewFileWithMetadata : Instantiate FileWithMetadata (Generic Model Constructor)

func (*CaseManagementV1) NewGetCaseOptions 

func (*CaseManagementV1) NewGetCaseOptions(caseNumber string) *GetCaseOptions

NewGetCaseOptions : Instantiate GetCaseOptions

func (*CaseManagementV1) NewGetCasesOptions 

func (*CaseManagementV1) NewGetCasesOptions() *GetCasesOptions

NewGetCasesOptions : Instantiate GetCasesOptions

func (*CaseManagementV1) NewGetCasesPager added in v0.28.7 

func (caseManagement *CaseManagementV1) NewGetCasesPager(options *GetCasesOptions) (pager *GetCasesPager, err error)

NewGetCasesPager returns a new GetCasesPager instance.

func (*CaseManagementV1) NewOffering 

func (*CaseManagementV1) NewOffering(name string, typeVar *OfferingType) (_model *Offering, err error)

NewOffering : Instantiate Offering (Generic Model Constructor)

func (*CaseManagementV1) NewOfferingType 

func (*CaseManagementV1) NewOfferingType(group string, key string) (_model *OfferingType, err error)

NewOfferingType : Instantiate OfferingType (Generic Model Constructor)

func (*CaseManagementV1) NewRemoveWatchlistOptions 

func (*CaseManagementV1) NewRemoveWatchlistOptions(caseNumber string) *RemoveWatchlistOptions

NewRemoveWatchlistOptions : Instantiate RemoveWatchlistOptions

func (*CaseManagementV1) NewResolvePayload 

func (*CaseManagementV1) NewResolvePayload(action string, resolutionCode int64) (_model *ResolvePayload, err error)

NewResolvePayload : Instantiate ResolvePayload (Generic Model Constructor)

func (*CaseManagementV1) NewUnresolvePayload 

func (*CaseManagementV1) NewUnresolvePayload(action string, comment string) (_model *UnresolvePayload, err error)

NewUnresolvePayload : Instantiate UnresolvePayload (Generic Model Constructor)

func (*CaseManagementV1) NewUpdateCaseStatusOptions 

func (*CaseManagementV1) NewUpdateCaseStatusOptions(caseNumber string, statusPayload StatusPayloadIntf) *UpdateCaseStatusOptions

NewUpdateCaseStatusOptions : Instantiate UpdateCaseStatusOptions

func (*CaseManagementV1) NewUploadFileOptions 

func (*CaseManagementV1) NewUploadFileOptions(caseNumber string, file []FileWithMetadata) *UploadFileOptions

NewUploadFileOptions : Instantiate UploadFileOptions

func (*CaseManagementV1) NewUser 

func (*CaseManagementV1) NewUser(realm string, userID string) (_model *User, err error)

NewUser : Instantiate User (Generic Model Constructor)

func (*CaseManagementV1) RemoveWatchlist 

func (caseManagement *CaseManagementV1) RemoveWatchlist(removeWatchlistOptions *RemoveWatchlistOptions) (result *Watchlist, response *core.DetailedResponse, err error)

RemoveWatchlist : Remove users from watchlist of case Remove users from the watchlist of a case if you don't want them to view the case, receive updates, or make updates to the case.

func (*CaseManagementV1) RemoveWatchlistWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) RemoveWatchlistWithContext(ctx context.Context, removeWatchlistOptions *RemoveWatchlistOptions) (result *Watchlist, response *core.DetailedResponse, err error)

RemoveWatchlistWithContext is an alternate form of the RemoveWatchlist method which supports a Context parameter

func (*CaseManagementV1) SetDefaultHeaders added in v0.12.2 

func (caseManagement *CaseManagementV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*CaseManagementV1) SetEnableGzipCompression added in v0.12.2 

func (caseManagement *CaseManagementV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*CaseManagementV1) SetServiceURL 

func (caseManagement *CaseManagementV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*CaseManagementV1) UpdateCaseStatus 

func (caseManagement *CaseManagementV1) UpdateCaseStatus(updateCaseStatusOptions *UpdateCaseStatusOptions) (result *Case, response *core.DetailedResponse, err error)

UpdateCaseStatus : Update case status Mark the case as resolved or unresolved, or accept the provided resolution.

func (*CaseManagementV1) UpdateCaseStatusWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) UpdateCaseStatusWithContext(ctx context.Context, updateCaseStatusOptions *UpdateCaseStatusOptions) (result *Case, response *core.DetailedResponse, err error)

UpdateCaseStatusWithContext is an alternate form of the UpdateCaseStatus method which supports a Context parameter

func (*CaseManagementV1) UploadFile 

func (caseManagement *CaseManagementV1) UploadFile(uploadFileOptions *UploadFileOptions) (result *Attachment, response *core.DetailedResponse, err error)

UploadFile : Add attachments to a support case You can add attachments to a case to provide more information for the support team about the issue that you're experiencing.

func (*CaseManagementV1) UploadFileWithContext added in v0.12.2 

func (caseManagement *CaseManagementV1) UploadFileWithContext(ctx context.Context, uploadFileOptions *UploadFileOptions) (result *Attachment, response *core.DetailedResponse, err error)

UploadFileWithContext is an alternate form of the UploadFile method which supports a Context parameter

type CaseManagementV1Options 

type CaseManagementV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

CaseManagementV1Options : Service options

type CasePayloadEu 

type CasePayloadEu struct {
	// indicating whether the case is EU supported.
	Supported *bool `json:"supported,omitempty"`

	// If EU supported utility endpoint specifies data center, then pass the data center id to mark a case as EU supported.
	DataCenter *int64 `json:"data_center,omitempty"`
}

CasePayloadEu : Specify if the case should be treated as EU regulated. Only one of the following properties is required. Call EU support utility endpoint to determine which property must be specified for your account.

type Comment 

type Comment struct {
	// The comment.
	Value *string `json:"value,omitempty"`

	// Date time when comment was added in UTC.
	AddedAt *string `json:"added_at,omitempty"`

	// User info in a case.
	AddedBy *User `json:"added_by,omitempty"`
}

Comment : A comment in a case.

type CreateCaseOptions 

type CreateCaseOptions struct {
	// Case type.
	Type *string `json:"type" validate:"required"`

	// Short description used to identify the case.
	Subject *string `json:"subject" validate:"required"`

	// Detailed description of the issue.
	Description *string `json:"description" validate:"required"`

	// Severity of the case. Smaller values mean higher severity.
	Severity *int64 `json:"severity,omitempty"`

	// Specify if the case should be treated as EU regulated. Only one of the following properties is required. Call EU
	// support utility endpoint to determine which property must be specified for your account.
	Eu *CasePayloadEu `json:"eu,omitempty"`

	// Offering details.
	Offering *Offering `json:"offering,omitempty"`

	// List of resources to attach to case. If you attach Classic IaaS devices, use the type and id fields if the Cloud
	// Resource Name (CRN) is unavailable. Otherwise, pass the resource CRN. The resource list must be consistent with the
	// value that is selected for the resource offering.
	Resources []ResourcePayload `json:"resources,omitempty"`

	// Array of user IDs to add to the watchlist.
	Watchlist []User `json:"watchlist,omitempty"`

	// Invoice number of "Billing and Invoice" case type.
	InvoiceNumber *string `json:"invoice_number,omitempty"`

	// Flag to indicate if case is for an Service Level Agreement (SLA) credit request.
	SLACreditRequest *bool `json:"sla_credit_request,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateCaseOptions : The CreateCase options.

func (*CreateCaseOptions) SetDescription 

func (_options *CreateCaseOptions) SetDescription(description string) *CreateCaseOptions

SetDescription : Allow user to set Description

func (*CreateCaseOptions) SetEu 

func (_options *CreateCaseOptions) SetEu(eu *CasePayloadEu) *CreateCaseOptions

SetEu : Allow user to set Eu

func (*CreateCaseOptions) SetHeaders 

func (options *CreateCaseOptions) SetHeaders(param map[string]string) *CreateCaseOptions

SetHeaders : Allow user to set Headers

func (*CreateCaseOptions) SetInvoiceNumber 

func (_options *CreateCaseOptions) SetInvoiceNumber(invoiceNumber string) *CreateCaseOptions

SetInvoiceNumber : Allow user to set InvoiceNumber

func (*CreateCaseOptions) SetOffering 

func (_options *CreateCaseOptions) SetOffering(offering *Offering) *CreateCaseOptions

SetOffering : Allow user to set Offering

func (*CreateCaseOptions) SetResources 

func (_options *CreateCaseOptions) SetResources(resources []ResourcePayload) *CreateCaseOptions

SetResources : Allow user to set Resources

func (*CreateCaseOptions) SetSLACreditRequest added in v0.17.2 

func (_options *CreateCaseOptions) SetSLACreditRequest(slaCreditRequest bool) *CreateCaseOptions

SetSLACreditRequest : Allow user to set SLACreditRequest

func (*CreateCaseOptions) SetSeverity 

func (_options *CreateCaseOptions) SetSeverity(severity int64) *CreateCaseOptions

SetSeverity : Allow user to set Severity

func (*CreateCaseOptions) SetSubject 

func (_options *CreateCaseOptions) SetSubject(subject string) *CreateCaseOptions

SetSubject : Allow user to set Subject

func (*CreateCaseOptions) SetType 

func (_options *CreateCaseOptions) SetType(typeVar string) *CreateCaseOptions

SetType : Allow user to set Type

func (*CreateCaseOptions) SetWatchlist 

func (_options *CreateCaseOptions) SetWatchlist(watchlist []User) *CreateCaseOptions

SetWatchlist : Allow user to set Watchlist

type DeleteFileOptions 

type DeleteFileOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Unique identifier of a file.
	FileID *string `json:"file_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteFileOptions : The DeleteFile options.

func (*DeleteFileOptions) SetCaseNumber 

func (_options *DeleteFileOptions) SetCaseNumber(caseNumber string) *DeleteFileOptions

SetCaseNumber : Allow user to set CaseNumber

func (*DeleteFileOptions) SetFileID 

func (_options *DeleteFileOptions) SetFileID(fileID string) *DeleteFileOptions

SetFileID : Allow user to set FileID

func (*DeleteFileOptions) SetHeaders 

func (options *DeleteFileOptions) SetHeaders(param map[string]string) *DeleteFileOptions

SetHeaders : Allow user to set Headers

type DownloadFileOptions 

type DownloadFileOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Unique identifier of a file.
	FileID *string `json:"file_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DownloadFileOptions : The DownloadFile options.

func (*DownloadFileOptions) SetCaseNumber 

func (_options *DownloadFileOptions) SetCaseNumber(caseNumber string) *DownloadFileOptions

SetCaseNumber : Allow user to set CaseNumber

func (*DownloadFileOptions) SetFileID 

func (_options *DownloadFileOptions) SetFileID(fileID string) *DownloadFileOptions

SetFileID : Allow user to set FileID

func (*DownloadFileOptions) SetHeaders 

func (options *DownloadFileOptions) SetHeaders(param map[string]string) *DownloadFileOptions

SetHeaders : Allow user to set Headers

type FileWithMetadata 

type FileWithMetadata struct {
	// The data / content for the file.
	Data io.ReadCloser `json:"data" validate:"required"`

	// The filename of the file.
	Filename *string `json:"filename,omitempty"`

	// The content type of the file.
	ContentType *string `json:"content_type,omitempty"`
}

FileWithMetadata : A file with its associated metadata.

type GetCaseOptions 

type GetCaseOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Selected fields of interest instead of all of the case information.
	Fields []string `json:"fields,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCaseOptions : The GetCase options.

func (*GetCaseOptions) SetCaseNumber 

func (_options *GetCaseOptions) SetCaseNumber(caseNumber string) *GetCaseOptions

SetCaseNumber : Allow user to set CaseNumber

func (*GetCaseOptions) SetFields 

func (_options *GetCaseOptions) SetFields(fields []string) *GetCaseOptions

SetFields : Allow user to set Fields

func (*GetCaseOptions) SetHeaders 

func (options *GetCaseOptions) SetHeaders(param map[string]string) *GetCaseOptions

SetHeaders : Allow user to set Headers

type GetCasesOptions 

type GetCasesOptions struct {
	// Number of cases that are skipped.
	Offset *int64 `json:"offset,omitempty"`

	// Number of cases that are returned.
	Limit *int64 `json:"limit,omitempty"`

	// String that a case might contain.
	Search *string `json:"search,omitempty"`

	// Sort field and direction. If omitted, default to descending of updated date. Prefix "~" signifies sort in
	// descending.
	Sort *string `json:"sort,omitempty"`

	// Case status filter.
	Status []string `json:"status,omitempty"`

	// Selected fields of interest instead of all of the case information.
	Fields []string `json:"fields,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCasesOptions : The GetCases options.

func (*GetCasesOptions) SetFields 

func (_options *GetCasesOptions) SetFields(fields []string) *GetCasesOptions

SetFields : Allow user to set Fields

func (*GetCasesOptions) SetHeaders 

func (options *GetCasesOptions) SetHeaders(param map[string]string) *GetCasesOptions

SetHeaders : Allow user to set Headers

func (*GetCasesOptions) SetLimit 

func (_options *GetCasesOptions) SetLimit(limit int64) *GetCasesOptions

SetLimit : Allow user to set Limit

func (*GetCasesOptions) SetOffset 

func (_options *GetCasesOptions) SetOffset(offset int64) *GetCasesOptions

SetOffset : Allow user to set Offset

func (*GetCasesOptions) SetSearch 

func (_options *GetCasesOptions) SetSearch(search string) *GetCasesOptions

SetSearch : Allow user to set Search

func (*GetCasesOptions) SetSort 

func (_options *GetCasesOptions) SetSort(sort string) *GetCasesOptions

SetSort : Allow user to set Sort

func (*GetCasesOptions) SetStatus 

func (_options *GetCasesOptions) SetStatus(status []string) *GetCasesOptions

SetStatus : Allow user to set Status

type GetCasesPager added in v0.28.7 

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

GetCasesPager can be used to simplify the use of the "GetCases" method.

func (*GetCasesPager) GetAll added in v0.28.7 

func (pager *GetCasesPager) GetAll() (allItems []Case, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*GetCasesPager) GetAllWithContext added in v0.28.7 

func (pager *GetCasesPager) GetAllWithContext(ctx context.Context) (allItems []Case, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*GetCasesPager) GetNext added in v0.28.7 

func (pager *GetCasesPager) GetNext() (page []Case, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*GetCasesPager) GetNextWithContext added in v0.28.7 

func (pager *GetCasesPager) GetNextWithContext(ctx context.Context) (page []Case, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*GetCasesPager) HasNext added in v0.28.7 

func (pager *GetCasesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type Offering 

type Offering struct {
	// Name of the offering.
	Name *string `json:"name" validate:"required"`

	// Offering type.
	Type *OfferingType `json:"type" validate:"required"`
}

Offering : Offering details.

type OfferingType 

type OfferingType struct {
	// Offering type group. "crn_service_name" is preferred over "category" as the latter is legacy and will be deprecated
	// in the future.
	Group *string `json:"group" validate:"required"`

	// CRN service name of the offering.
	Key *string `json:"key" validate:"required"`

	// Optional. Platform kind of the offering.
	Kind *string `json:"kind,omitempty"`

	// Offering id in the catalog. This alone is enough to identify the offering.
	ID *string `json:"id,omitempty"`
}

OfferingType : Offering type. 

type PaginationLink struct {
	// URL to related pages of cases.
	Href *string `json:"href,omitempty"`
}

PaginationLink : Container for URL pointer to related pages of cases.

type RemoveWatchlistOptions 

type RemoveWatchlistOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Array of user ID objects.
	Watchlist []User `json:"watchlist,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

RemoveWatchlistOptions : The RemoveWatchlist options.

func (*RemoveWatchlistOptions) SetCaseNumber 

func (_options *RemoveWatchlistOptions) SetCaseNumber(caseNumber string) *RemoveWatchlistOptions

SetCaseNumber : Allow user to set CaseNumber

func (*RemoveWatchlistOptions) SetHeaders 

func (options *RemoveWatchlistOptions) SetHeaders(param map[string]string) *RemoveWatchlistOptions

SetHeaders : Allow user to set Headers

func (*RemoveWatchlistOptions) SetWatchlist 

func (_options *RemoveWatchlistOptions) SetWatchlist(watchlist []User) *RemoveWatchlistOptions

SetWatchlist : Allow user to set Watchlist

type ResolvePayload 

type ResolvePayload struct {
	// action to perform on the case.
	Action *string `json:"action" validate:"required"`

	// comment of resolution.
	Comment *string `json:"comment,omitempty"`

	// * 1: Client error
	// * 2: Defect found with Component/Service
	// * 3: Documentation Error
	// * 4: Solution found in forums
	// * 5: Solution found in public Documentation
	// * 6: Solution no longer required
	// * 7: Solution provided by IBM outside of support case
	// * 8: Solution provided by IBM support engineer.
	ResolutionCode *int64 `json:"resolution_code" validate:"required"`
}

ResolvePayload : Payload to resolve the case. This model "extends" StatusPayload

type Resource 

type Resource struct {
	// ID of the resource.
	CRN *string `json:"crn,omitempty"`

	// Name of the resource.
	Name *string `json:"name,omitempty"`

	// Type of resource.
	Type *string `json:"type,omitempty"`

	// URL of resource.
	URL *string `json:"url,omitempty"`

	// Note about resource.
	Note *string `json:"note,omitempty"`
}

Resource : A resource record of a case.

type ResourcePayload 

type ResourcePayload struct {
	// Cloud Resource Name of the resource.
	CRN *string `json:"crn,omitempty"`

	// Only used to attach Classic IaaS devices that have no CRN.
	Type *string `json:"type,omitempty"`

	// Only used to attach Classic IaaS devices that have no CRN. Id of Classic IaaS device. This is deprecated in favor of
	// the crn field.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ID *float64 `json:"id,omitempty"`

	// A note about this resource.
	Note *string `json:"note,omitempty"`
}

ResourcePayload : Payload to add a resource to a case.

type StatusPayload 

type StatusPayload struct {
	// action to perform on the case.
	Action *string `json:"action" validate:"required"`

	// comment of resolution.
	Comment *string `json:"comment,omitempty"`

	// * 1: Client error
	// * 2: Defect found with Component/Service
	// * 3: Documentation Error
	// * 4: Solution found in forums
	// * 5: Solution found in public Documentation
	// * 6: Solution no longer required
	// * 7: Solution provided by IBM outside of support case
	// * 8: Solution provided by IBM support engineer.
	ResolutionCode *int64 `json:"resolution_code,omitempty"`
}

StatusPayload : Payload to update status of the case. Models which "extend" this model: - ResolvePayload - UnresolvePayload - AcceptPayload

type StatusPayloadIntf 

type StatusPayloadIntf interface {
	// contains filtered or unexported methods
}

type UnresolvePayload 

type UnresolvePayload struct {
	// action to perform on the case.
	Action *string `json:"action" validate:"required"`

	// Comment why the case should be unresolved.
	Comment *string `json:"comment" validate:"required"`
}

UnresolvePayload : Payload to unresolve the case. This model "extends" StatusPayload

type UpdateCaseStatusOptions 

type UpdateCaseStatusOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// Payload to update status of the case.
	StatusPayload StatusPayloadIntf `json:"StatusPayload" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateCaseStatusOptions : The UpdateCaseStatus options.

func (*UpdateCaseStatusOptions) SetCaseNumber 

func (_options *UpdateCaseStatusOptions) SetCaseNumber(caseNumber string) *UpdateCaseStatusOptions

SetCaseNumber : Allow user to set CaseNumber

func (*UpdateCaseStatusOptions) SetHeaders 

func (options *UpdateCaseStatusOptions) SetHeaders(param map[string]string) *UpdateCaseStatusOptions

SetHeaders : Allow user to set Headers

func (*UpdateCaseStatusOptions) SetStatusPayload 

func (_options *UpdateCaseStatusOptions) SetStatusPayload(statusPayload StatusPayloadIntf) *UpdateCaseStatusOptions

SetStatusPayload : Allow user to set StatusPayload

type UploadFileOptions 

type UploadFileOptions struct {
	// Unique identifier of a case.
	CaseNumber *string `json:"case_number" validate:"required,ne="`

	// file of supported types, 8MB in size limit.
	File []FileWithMetadata `json:"file" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UploadFileOptions : The UploadFile options.

func (*UploadFileOptions) SetCaseNumber 

func (_options *UploadFileOptions) SetCaseNumber(caseNumber string) *UploadFileOptions

SetCaseNumber : Allow user to set CaseNumber

func (*UploadFileOptions) SetFile 

func (_options *UploadFileOptions) SetFile(file []FileWithMetadata) *UploadFileOptions

SetFile : Allow user to set File

func (*UploadFileOptions) SetHeaders 

func (options *UploadFileOptions) SetHeaders(param map[string]string) *UploadFileOptions

SetHeaders : Allow user to set Headers

type User 

type User struct {
	// Full name of the user.
	Name *string `json:"name,omitempty"`

	// the ID realm.
	Realm *string `json:"realm" validate:"required"`

	// unique user ID in the realm specified by the type.
	UserID *string `json:"user_id" validate:"required"`
}

User : User info in a case.

type Watchlist 

type Watchlist struct {
	// Array of user ID objects.
	Watchlist []User `json:"watchlist,omitempty"`
}

Watchlist : Payload to add/remove users to/from the case watchlist.

type WatchlistAddResponse 

type WatchlistAddResponse struct {
	// List of added user.
	Added []User `json:"added,omitempty"`

	// List of failed to add user.
	Failed []User `json:"failed,omitempty"`
}

WatchlistAddResponse : Response of a request when adding to watchlist.

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.