service_order_status

Documentation

Overview

Package service_order_status contains order management functionality on security

Index

• type GetOpts
  • func (opts GetOpts) ToServiceOrderQuery() (string, error)
• type GetOptsBuilder
• type GetResult
  • func Get(client *eclcloud.ServiceClient, deviceType string, opts GetOptsBuilder) (r GetResult)
  • func (r GetResult) Extract() (*OrderProgress, error)
  • func (r GetResult) ExtractInto(v interface{}) error
• type OrderProgress

Types

type GetOpts

type GetOpts struct {
	TenantID string `q:"tenant_id"`
	Locale   string `q:"locale"`
	SoID     string `q:"soid"`
}

GetOpts represents result of order progress API response.

func (GetOpts) ToServiceOrderQuery

func (opts GetOpts) ToServiceOrderQuery() (string, error)

ToServiceOrderQuery formats a GetOpts into a query string.

type GetOptsBuilder

type GetOptsBuilder interface {
	ToServiceOrderQuery() (string, error)
}

GetOptsBuilder allows extensions to add additional parameters to the order progress API request

type GetResult

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

GetResult represents the result of a get operation. Call its Extract method to interpret it as an Order.

func Get

func Get(client *eclcloud.ServiceClient, deviceType string, opts GetOptsBuilder) (r GetResult)

Get retrieves details of an order progress, by SoId.

func (GetResult) Extract

func (r GetResult) Extract() (*OrderProgress, error)

Extract is a function that accepts a result and extracts an Order Progress resource.

func (GetResult) ExtractInto

func (r GetResult) ExtractInto(v interface{}) error

Extract interprets any commonResult as an Order Progress, if possible.

type OrderProgress

type OrderProgress struct {
	Status       int    `json:"status"`
	Code         string `json:"code"`
	Message      string `json:"message"`
	ProgressRate int    `json:"progressRate"`
}

OrderProgress represents an Order Progress response.