models

type AccessGrant struct {

	// The access status of the AccessGrant.
	Access string `json:"access,omitempty"`

	// The date and time, in UTC, the AccessGrant was created. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The token for the User who created the AccessGrant.
	CreatedBy string `json:"created_by,omitempty"`

	// The token for any resource the AccessGrant is applied to.
	// Example: rprt_abcd1234
	ResourceToken string `json:"resource_token,omitempty"`

	// The Team token for which an AccessGrant is applied to.
	TeamToken string `json:"team_token,omitempty"`

	// token
	Token string `json:"token,omitempty"`
}

type AccessGrants struct {

	// access grants
	AccessGrants []*AccessGrant `json:"access_grants"`

	// links
	Links interface{} `json:"links,omitempty"`
}

type CostReport struct {

	// The date and time, in UTC, the report was created. ISO 8601 Formatted.
	// Example: 2021-07-09T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The filter applied to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token for the Folder the CostReport is a part of.
	FolderToken string `json:"folder_token,omitempty"`

	// The tokens for the SavedFilters assigned to the CostReport.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the CostReport.
	// Example: Production Environment
	Title string `json:"title,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// The token for the Workspace the CostReport is a part of.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type CostReports struct {

	// cost reports
	CostReports []*CostReport `json:"cost_reports"`

	// links
	Links interface{} `json:"links,omitempty"`
}

type Costs struct {

	// costs
	Costs []string `json:"costs"`

	// links
	Links interface{} `json:"links,omitempty"`

	// The sum of all costs for the CostReport for the requested period, rounded to 2 decimal places, alongside the ISO 4217 currency code.
	TotalCost string `json:"total_cost,omitempty"`
}

type Dashboard struct {

	// The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// Determines how to group costs in the Dashboard.
	// Enum: [cumulative day week month]
	DateBin string `json:"date_bin,omitempty"`

	// Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'start_date' and 'end_date' are set.
	// Enum: [this_month last_7_days last_30_days last_month last_3_months last_6_months custom last_12_months last_24_months last_36_months]
	DateInterval string `json:"date_interval,omitempty"`

	// The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
	// Example: 2023-09-04
	EndDate string `json:"end_date,omitempty"`

	// The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
	// Example: 2023-08-04
	StartDate string `json:"start_date,omitempty"`

	// The title of the Dashboard.
	// Example: AWS Dashboard
	Title string `json:"title,omitempty"`

	// token
	// Example: dshbrd_abcd1234567890
	Token string `json:"token,omitempty"`

	// The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	UpdatedAt string `json:"updated_at,omitempty"`

	// The tokens of the widgets displayed in the Dashboard. Currently only supports CostReport tokens.
	WidgetTokens []string `json:"widget_tokens"`

	// The token for the Workspace the Dashboard is a part of.
	// Example: wrkspc_abcd1234567890
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type Dashboards struct {

	// dashboards
	Dashboards []*Dashboard `json:"dashboards"`

	// links
	Links interface{} `json:"links,omitempty"`
}

type Errors struct {

	// errors
	Errors []string `json:"errors"`

	// links
	Links interface{} `json:"links,omitempty"`
}

type Folder struct {

	// The date and time, in UTC, the Folder was created. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The token for the parent Folder, if any.
	ParentFolderToken string `json:"parent_folder_token,omitempty"`

	// The tokens for the SavedFilters assigned to the Folder.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the Folder.
	// Example: Platform Team Reports
	Title string `json:"title,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// The date and time, in UTC, the Folder was last updated at. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	UpdatedAt string `json:"updated_at,omitempty"`

	// The token for the Workspace the Folder is a part of.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type Folders struct {

	// folders
	Folders []*Folder `json:"folders"`

	// links
	Links interface{} `json:"links,omitempty"`
}

type PostAccessGrants struct {

	// The access level you want to grant. Defaults to 'allowed'.
	// Enum: [denied allowed]
	Access string `json:"access,omitempty"`

	// The token of the resource for which you are granting access.
	// Required: true
	ResourceToken *string `json:"resource_token"`

	// The token of the Team you want to grant access to.
	// Required: true
	TeamToken *string `json:"team_token"`
}

type PostCostReports struct {

	// The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to.
	FolderToken string `json:"folder_token,omitempty"`

	// The tokens of the SavedFilters to apply to the CostReport.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the CostReport.
	// Required: true
	Title *string `json:"title"`

	// The token of the Workspace to add the Cost Report to. Ignored if 'folder_token' is set. Required if the API token is associated with multiple Workspaces.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type PostDashboards struct {

	// Determines how to group costs in the Dashboard.
	// Enum: [cumulative day week month]
	DateBin string `json:"date_bin,omitempty"`

	// Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters.
	// Enum: [this_month last_7_days last_30_days last_month last_3_months last_6_months custom last_12_months last_24_months last_36_months]
	DateInterval string `json:"date_interval,omitempty"`

	// The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
	// Required: true
	EndDate *string `json:"end_date"`

	// The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
	StartDate string `json:"start_date,omitempty"`

	// The title of the Dashboard.
	// Required: true
	Title *string `json:"title"`

	// The tokens of the widgets to add to the Dashboard. Currently only supports CostReport tokens.
	WidgetTokens []string `json:"widget_tokens"`

	// The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type PostFolders struct {

	// The token of the parent Folder.
	ParentFolderToken string `json:"parent_folder_token,omitempty"`

	// The tokens of the SavedFilters to apply to any Cost Report contained within the Folder.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the Folder.
	// Required: true
	Title *string `json:"title"`

	// The token of the Workspace to add the Folder to. Ignored if 'parent_folder_token' is set. Required if the API token is associated with multiple Workspaces.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type PostReportsFolders struct {

	// The token of the parent Folder.
	ParentFolderToken string `json:"parent_folder_token,omitempty"`

	// The title of the Folder.
	// Required: true
	Title *string `json:"title"`
}

type PostSavedFilters struct {

	// The filter query language to apply to the SavedFilter, which subsequently gets applied to a CostReport. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The title of the SavedFilter.
	// Required: true
	Title *string `json:"title"`

	// The Workspace to associate the SavedFilter with. Required if the API token is associated with multiple Workspaces.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type PostSegments struct {

	// The description of the Segment.
	Description string `json:"description,omitempty"`

	// The filter query language to apply to the Segment. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token of the parent Segment this new Segment belongs to. Determines the Workspace the segment is assigned to.
	ParentSegmentToken string `json:"parent_segment_token,omitempty"`

	// The priority of the Segment.
	Priority int32 `json:"priority,omitempty"`

	// The title of the Segment.
	// Required: true
	Title *string `json:"title"`

	// Track Unallocated Costs which are not assigned to any of the created Segments.
	TrackUnallocated *bool `json:"track_unallocated,omitempty"`

	// The token of the Workspace to add the Segment to. Ignored if 'segment_token' is set. Required if the API token is associated with multiple Workspaces.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type PostTeams struct {

	// The description of the Team.
	Description string `json:"description,omitempty"`

	// The name of the Team.
	// Required: true
	Name *string `json:"name"`

	// The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
	// Enum: [owner editor viewer]
	Role string `json:"role,omitempty"`

	// The User emails to associate to the Team.
	UserEmails []string `json:"user_emails"`

	// The User tokens to associate to the Team.
	UserTokens []string `json:"user_tokens"`

	// The Workspace tokens to associate to the Team.
	WorkspaceTokens []string `json:"workspace_tokens"`
}

type Price struct {

	// The amount of money this specific product price costs.
	// Example: 1.324
	Amount float64 `json:"amount,omitempty"`

	// The currency of the amount.
	// Example: USD
	Currency string `json:"currency,omitempty"`

	// Service specific metadata.
	// Example: {"lifecycle":"on-demand","platform":"linux-enterprise"}
	Details interface{} `json:"details,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// The part of the product the price applies to. (compute, transfer, etc..)
	// Example: compute
	RateType string `json:"rate_type,omitempty"`

	// The region the price is specific to.
	// Example: us-east-1
	Region string `json:"region,omitempty"`

	// The unit in which the amount is billed.
	// Example: hour
	Unit string `json:"unit,omitempty"`
}

type Prices struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// prices
	Prices []*Price `json:"prices"`
}

type Product struct {

	// The category of the cloud product
	// Example: compute
	Category string `json:"category,omitempty"`

	// An object of metadata about the product.
	// Example: {"clock_speed_ghz":3.1,"gpu":0,"memory":256,"name":"M5 General Purpose 16xlarge","network_performance_description":"20 Gigabit","physical_processor_description":"Intel Xeon Platinum 8175 (Skylake)","vcpu":64}
	Details interface{} `json:"details,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// The common name of the product.
	// Example: EC2
	Name string `json:"name,omitempty"`

	// A unique slug for the provider the product belongs to.
	// Example: aws
	ProviderID string `json:"provider_id,omitempty"`

	// A unique slug for the service the product belongs to.
	// Example: aws-ec2
	ServiceID string `json:"service_id,omitempty"`
}

type Products struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// products
	Products []*Product `json:"products"`
}

type PutAccessGrants struct {

	// Allowed or denied access to resource.
	// Required: true
	// Enum: [denied allowed]
	Access *string `json:"access"`
}

type PutCostReports struct {

	// The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to.
	FolderToken string `json:"folder_token,omitempty"`

	// The tokens of the SavedFilters to apply to the CostReport.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the CostReport.
	Title string `json:"title,omitempty"`
}

type PutDashboards struct {

	// Determines how to group costs in the Dashboard.
	// Enum: [cumulative day week month]
	DateBin string `json:"date_bin,omitempty"`

	// Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters.
	// Enum: [this_month last_7_days last_30_days last_month last_3_months last_6_months custom last_12_months last_24_months last_36_months]
	DateInterval string `json:"date_interval,omitempty"`

	// The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
	// Required: true
	EndDate *string `json:"end_date"`

	// The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
	StartDate string `json:"start_date,omitempty"`

	// The title of the Dashboard.
	Title string `json:"title,omitempty"`

	// The tokens of the widgets to add to the Dashboard. Currently only supports CostReport tokens.
	WidgetTokens []string `json:"widget_tokens"`
}

type PutFolders struct {

	// The token of the parent Folder.
	ParentFolderToken string `json:"parent_folder_token,omitempty"`

	// The tokens of the SavedFilters to apply to any Cost Report contained within the Folder.
	SavedFilterTokens []string `json:"saved_filter_tokens"`

	// The title of the Folder.
	Title string `json:"title,omitempty"`
}

type PutReportsFolders struct {

	// The token of the parent Folder.
	ParentFolderToken string `json:"parent_folder_token,omitempty"`

	// The title of the Folder.
	Title string `json:"title,omitempty"`
}

type PutSavedFilters struct {

	// The filter query language to apply to the SavedFilter, which subsequently gets applied to a CostReport. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The title of the SavedFilter.
	Title string `json:"title,omitempty"`
}

type PutSegments struct {

	// The description of the Segment.
	Description string `json:"description,omitempty"`

	// The filter query language to apply to the Segment. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token of the parent Segment this new Segment belongs to. Determines the Workspace the segment is assigned to.
	ParentSegmentToken string `json:"parent_segment_token,omitempty"`

	// The priority of the Segment.
	Priority int32 `json:"priority,omitempty"`

	// The title of the Segment.
	Title string `json:"title,omitempty"`

	// Track Unallocated Costs which are not assigned to any of the created Segments.
	TrackUnallocated *bool `json:"track_unallocated,omitempty"`
}

type PutTeams struct {

	// The description of the Team.
	Description string `json:"description,omitempty"`

	// The name of the Team.
	Name string `json:"name,omitempty"`

	// The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.
	// Enum: [owner editor viewer]
	Role string `json:"role,omitempty"`

	// The User emails to associate to the Team.
	UserEmails []string `json:"user_emails"`

	// The User tokens to associate to the Team.
	UserTokens []string `json:"user_tokens"`

	// The Workspace tokens to associate to the Team.
	WorkspaceTokens []string `json:"workspace_tokens"`
}

type Report struct {

	// The date and time, in UTC, the report was created. ISO 8601 Formatted.
	// Example: 2021-07-09T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The token for the Folder the Cost Report is a part of.
	Folder string `json:"folder,omitempty"`

	// The tokens for the Shared Filters assigned to the Cost Report.
	SharedFilters string `json:"shared_filters,omitempty"`

	// The title of the Cost Report.
	// Example: Production Environment
	Title string `json:"title,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// The token for the Workspace the Cost Report is a part of.
	Workspace string `json:"workspace,omitempty"`
}

type Reports struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// reports
	Reports []*CostReport `json:"reports"`
}

type SavedFilter struct {

	// The tokens for any CostReports the SavedFilter is applied to.
	CostReportTokens []string `json:"cost_report_tokens"`

	// The date and time, in UTC, the report was created. ISO 8601 Formatted.
	// Example: 2023-08-04T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The User who created the SavedFilter.
	CreatedBy string `json:"created_by,omitempty"`

	// The SavedFilter's filter, applied to any relevant CostReports. Additional documentation available at https://docs.vantage.sh/vql.
	// Example: costs.provider = 'azure'
	Filter string `json:"filter,omitempty"`

	// The title of the SavedFilter.
	// Example: Platform Team Reports
	Title string `json:"title,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// The token for the Workspace the SavedFilter is a part of.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type SavedFilters struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// saved filters
	SavedFilters []*SavedFilter `json:"saved_filters"`
}

type Segment struct {

	// The date and time, in UTC, the segment was created. ISO 8601 Formatted.
	// Example: 2021-07-09T00:00:00Z
	CreatedAt string `json:"created_at,omitempty"`

	// The description of the Segment.
	// Example: Operating expenses
	Description string `json:"description,omitempty"`

	// The filter applied to the SegmentFilter. Additional documentation available at https://docs.vantage.sh/vql.
	Filter string `json:"filter,omitempty"`

	// The token of the parent segment of this Segment.
	ParentSegmentToken string `json:"parent_segment_token,omitempty"`

	// Costs are assigned in priority order across all segments with assigned filters.
	// Example: 100
	Priority int32 `json:"priority,omitempty"`

	// The title of the Segment.
	// Example: OPEX
	Title string `json:"title,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// Track Unallocated Costs which are not assigned to any of the created segments.
	// Example: false
	TrackUnallocated bool `json:"track_unallocated,omitempty"`

	// The token for the Workspace the Segment is a part of.
	WorkspaceToken string `json:"workspace_token,omitempty"`
}

type Segments struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// segments
	Segments []*Segment `json:"segments"`
}

type Team struct {

	// The description of the Team.
	// Example: The Team that saves costs
	Description string `json:"description,omitempty"`

	// The name of the Team.
	// Example: Cost Savers
	Name string `json:"name,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// The email addresses for Users that belong to the Team
	UserEmails []string `json:"user_emails"`

	// The tokens for Users that belong to the Team
	UserTokens []string `json:"user_tokens"`

	// The tokens for any Workspaces that the Team belongs to
	WorkspaceTokens []string `json:"workspace_tokens"`
}

type Teams struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// teams
	Teams []*Team `json:"teams"`
}

type User struct {

	// The email of the User.
	// Example: john_doe@acme.com
	Email string `json:"email,omitempty"`

	// The name of the User.
	// Example: John Doe
	Name string `json:"name,omitempty"`

	// The role of the User.
	// Example: Admin
	Role string `json:"role,omitempty"`

	// token
	Token string `json:"token,omitempty"`
}

type Users struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// users
	Users []*User `json:"users"`
}

type Workspace struct {

	// The name of the Workspace.
	// Example: Acme Corp.
	Name string `json:"name,omitempty"`

	// token
	Token string `json:"token,omitempty"`
}

type Workspaces struct {

	// links
	Links interface{} `json:"links,omitempty"`

	// workspaces
	Workspaces []*Workspace `json:"workspaces"`
}