assets

Documentation

Index

• type AQLAssetConnector
• type IconConnector
• type ObjectConnector
• type ObjectSchemaConnector
• type ObjectTypeAttributeConnector
• type ObjectTypeConnector

Types

type AQLAssetConnector

type AQLAssetConnector interface {

	// Filter search objects based on Assets Query Language (AQL)
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/aql/objects
	//
	// Deprecated. Please use Object.Filter() instead.
	//
	// https://docs.go-atlassian.io/jira-assets/aql#filter-objects
	Filter(ctx context.Context, workspaceID string, parameters *models.AQLSearchParamsScheme) (*models.ObjectListScheme, *models.ResponseScheme, error)
}

AQLAssetConnector represents the assets AQL search endpoints. Use it to execute AQL searches.

type IconConnector

type IconConnector interface {

	// Get loads a single asset icon by id.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/icon/{id}
	//
	// https://docs.go-atlassian.io/jira-assets/icons#get-icon
	Get(ctx context.Context, workspaceID, iconID string) (*models.IconScheme, *models.ResponseScheme, error)

	// Global returns all global icons i.e. icons not associated with a particular object schema.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/icon/global
	//
	// https://docs.go-atlassian.io/jira-assets/icons#get-global-icons
	Global(ctx context.Context, workspaceID string) ([]*models.IconScheme, *models.ResponseScheme, error)
}

IconConnector represents the assets icons endpoints. Use it to search and get asset icons.

type ObjectConnector

type ObjectConnector interface {

	// Get loads one object.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}
	//
	// https://docs.go-atlassian.io/jira-assets/object#get-object-by-id
	Get(ctx context.Context, workspaceID, objectID string) (*models.ObjectScheme, *models.ResponseScheme, error)

	// Update updates an existing object in Assets.
	//
	// PUT /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}
	//
	// https://docs.go-atlassian.io/jira-assets/object#update-object-by-id
	Update(ctx context.Context, workspaceID, objectID string, payload *models.ObjectPayloadScheme) (*models.ObjectScheme, *models.ResponseScheme, error)

	// Delete deletes the referenced object
	//
	// DELETE /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}
	//
	// https://docs.go-atlassian.io/jira-assets/object#delete-object-by-id
	Delete(ctx context.Context, workspaceID, objectID string) (*models.ResponseScheme, error)

	// Attributes list all attributes for the given object.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}/attributes
	//
	// https://docs.go-atlassian.io/jira-assets/object#get-object-attributes
	Attributes(ctx context.Context, workspaceID, objectID string) ([]*models.ObjectAttributeScheme, *models.ResponseScheme, error)

	// History retrieves the history entries for this object.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}/history
	//
	// https://docs.go-atlassian.io/jira-assets/object#get-object-changelogs
	History(ctx context.Context, workspaceID, objectID string, ascOrder bool) ([]*models.ObjectHistoryScheme, *models.ResponseScheme, error)

	// References finds all references for an object.
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/object/{objectID}/referenceinfo
	//
	// https://docs.go-atlassian.io/jira-assets/object#get-object-references
	References(ctx context.Context, workspaceID, objectID string) ([]*models.ObjectReferenceTypeInfoScheme, *models.ResponseScheme, error)

	// Create creates a new object in Assets.
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/object/create
	//
	// https://docs.go-atlassian.io/jira-assets/object#create-object
	Create(ctx context.Context, workspaceID string, payload *models.ObjectPayloadScheme) (*models.ObjectScheme, *models.ResponseScheme, error)

	// Relation returns the relation between Jira issues and Assets objects
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objectconnectedtickets/{objectID}/tickets
	//
	// https://docs.go-atlassian.io/jira-assets/object#get-object-tickets
	Relation(ctx context.Context, workspaceID, objectID string) (*models.TicketPageScheme, *models.ResponseScheme, error)

	// Filter fetch Objects by AQL.
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/object/aql
	//
	// https://docs.go-atlassian.io/jira-assets/object#filter-objects
	Filter(ctx context.Context, workspaceID, aql string, attributes bool, startAt, maxResults int) (*models.ObjectListResultScheme, *models.ResponseScheme, error)

	// Search retrieve a list of objects based on an AQL.
	//
	// Note that the preferred endpoint is /aql
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/object/navlist/aql
	//
	// https://docs.go-atlassian.io/jira-assets/object#search-objects
	Search(ctx context.Context, workspaceID string, payload *models.ObjectSearchParamsScheme) (*models.ObjectListScheme, *models.ResponseScheme, error)
}

ObjectConnector represents the Assets objects. Use it to search, get, create, delete, and change objects.

type ObjectSchemaConnector

type ObjectSchemaConnector interface {

	// List returns all the object schemas available on Assets
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objectschema/list
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#get-object-schema-list
	List(ctx context.Context, workspaceID string) (*models.ObjectSchemaPageScheme, *models.ResponseScheme, error)

	// Create creates a new object schema
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/objectschema/create
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#create-object-schema
	Create(ctx context.Context, workspaceID string, payload *models.ObjectSchemaPayloadScheme) (*models.ObjectSchemaScheme,
		*models.ResponseScheme, error)

	// Get returns an object schema by ID
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objectschema/{objectSchemaID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#get-object-schema
	Get(ctx context.Context, workspaceID, objectSchemaID string) (*models.ObjectSchemaScheme, *models.ResponseScheme, error)

	// Update updates an object schema
	//
	// PUT /jsm/assets/workspace/{workspaceID}/v1/objectschema/{objectSchemaID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#update-object-schema
	Update(ctx context.Context, workspaceID, objectSchemaID string, payload *models.ObjectSchemaPayloadScheme) (
		*models.ObjectSchemaScheme, *models.ResponseScheme, error)

	// Delete deletes a schema
	//
	// DELETE /jsm/assets/workspace/{workspaceID}/v1/objectschema/{objectSchemaID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#delete-object-schema
	Delete(ctx context.Context, workspaceID, objectSchemaID string) (*models.ObjectSchemaScheme, *models.ResponseScheme, error)

	// Attributes finds all object type attributes for this object schema
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objectschema/{objectSchemaID}/attributes
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#get-object-schema-attributes
	Attributes(ctx context.Context, workspaceID, objectSchemaID string, options *models.ObjectSchemaAttributesParamsScheme) (
		[]*models.ObjectTypeAttributeScheme, *models.ResponseScheme, error)

	// ObjectTypes returns all object types for this object schema
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objectschema/{objectSchemaID}/objecttypes
	//
	// https://docs.go-atlassian.io/jira-assets/object/schema#get-object-schema-types
	ObjectTypes(ctx context.Context, workspaceID, objectSchemaID string, excludeAbstract bool) (
		[]*models.ObjectTypeScheme, *models.ResponseScheme, error)
}

ObjectSchemaConnector represents the Assets object schemes. Use it to search, get, create, delete, and change schemes.

type ObjectTypeAttributeConnector

type ObjectTypeAttributeConnector interface {

	// Create creates a new attribute on the given object type
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/objecttypeattribute/{objectTypeID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type/attribute#create-object-type-attribute
	Create(ctx context.Context, workspaceID, objectTypeID string, payload *models.ObjectTypeAttributePayloadScheme) (
		*models.ObjectTypeAttributeScheme, *models.ResponseScheme, error)

	// Update updates an existing object type attribute
	//
	// PUT /jsm/assets/workspace/{workspaceID}/v1/objecttypeattribute/{objectTypeID}/{id}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type/attribute#update-object-type-attribute
	Update(ctx context.Context, workspaceID, objectTypeID, attributeID string, payload *models.ObjectTypeAttributePayloadScheme) (
		*models.ObjectTypeAttributeScheme, *models.ResponseScheme, error)

	// Delete deletes an existing object type attribute
	//
	// DELETE /jsm/assets/workspace/{workspaceID}/v1/objecttypeattribute/{attributeID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type/attribute#delete-object-type-attribute
	Delete(ctx context.Context, workspaceID, attributeID string) (*models.ResponseScheme, error)
}

ObjectTypeAttributeConnector represents the Assets object type attributes. Use it to search, get, create, delete, and change object type attributes.

type ObjectTypeConnector

type ObjectTypeConnector interface {

	// Get finds an object type by id
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objecttype/{objectTypeID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#get-object-type
	Get(ctx context.Context, workspaceID, objectTypeID string) (*models.ObjectTypeScheme, *models.ResponseScheme, error)

	// Update updates an existing object type
	//
	// PUT /jsm/assets/workspace/{workspaceID}/v1/objecttype/{objectTypeID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#update-object-type
	Update(ctx context.Context, workspaceID, objectTypeID string, payload *models.ObjectTypePayloadScheme) (
		*models.ObjectTypeScheme, *models.ResponseScheme, error)

	// Create creates a new object type
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/objecttype/create
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#create-object-type
	Create(ctx context.Context, workspaceID string, payload *models.ObjectTypePayloadScheme) (
		*models.ObjectTypeScheme, *models.ResponseScheme, error)

	// Delete deletes an object type
	//
	// DELETE /jsm/assets/workspace/{workspaceID}/v1/objecttype/{objectTypeID}
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#delete-object-type
	Delete(ctx context.Context, workspaceID, objectTypeID string) (*models.ObjectTypeScheme, *models.ResponseScheme, error)

	// Attributes finds all attributes for this object type
	//
	// GET /jsm/assets/workspace/{workspaceID}/v1/objecttype/{objectTypeID}/attributes
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#get-object-type-attributes
	Attributes(ctx context.Context, workspaceID, objectTypeID string, options *models.ObjectTypeAttributesParamsScheme) (
		[]*models.ObjectTypeAttributeScheme, *models.ResponseScheme, error)

	// Position changes the position of this object type
	//
	// POST /jsm/assets/workspace/{workspaceID}/v1/objecttype/{objectTypeID}/position
	//
	// https://docs.go-atlassian.io/jira-assets/object/type#update-object-type-position
	Position(ctx context.Context, workspaceID, objectTypeID string, payload *models.ObjectTypePositionPayloadScheme) (
		*models.ObjectTypeScheme, *models.ResponseScheme, error)
}

ObjectTypeConnector represents the Assets object types. Use it to search, get, create, delete, and change types.