shopify

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Index

• Variables
• func AnalyzeAndPrintPermissions(cfg *config.Config, key string, storeURL string)
• type AccessScopesJSON
  • func (a AccessScopesJSON) String() string
• type Analyzer
  • func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)
  • func (Analyzer) Type() analyzers.AnalyzerType
• type CategoryJSON
• type OutputScopes
  • func (o OutputScopes) PrintScopes() string
• type Permission
  • func PermissionFromID(id int) (Permission, error)
  • func PermissionFromString(s string) (Permission, error)
  • func (p Permission) ToID() (int, error)
  • func (p Permission) ToString() (string, error)
• type ScopeDataJSON
• type SecretInfo
  • func AnalyzePermissions(cfg *config.Config, key string, storeURL string) (*SecretInfo, error)
• type ShopInfoJSON

Variables

var (
	PermissionStrings = map[Permission]string{
		Read:       "read",
		Write:      "write",
		FullAccess: "full_access",
	}

	StringToPermission = map[string]Permission{
		"read":        Read,
		"write":       Write,
		"full_access": FullAccess,
	}

	PermissionIDs = map[Permission]int{
		Read:       1,
		Write:      2,
		FullAccess: 3,
	}

	IdToPermission = map[int]Permission{
		1: Read,
		2: Write,
		3: FullAccess,
	}
)

Functions

func AnalyzeAndPrintPermissions

func AnalyzeAndPrintPermissions(cfg *config.Config, key string, storeURL string)

Types

type AccessScopesJSON

type AccessScopesJSON struct {
	AccessScopes []struct {
		Handle string `json:"handle"`
	} `json:"access_scopes"`
}

func (AccessScopesJSON) String

func (a AccessScopesJSON) String() string

type Analyzer

type Analyzer struct {
	Cfg *config.Config
}

func (Analyzer) Analyze

func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)

func (Analyzer) Type

func (Analyzer) Type() analyzers.AnalyzerType

type CategoryJSON

type CategoryJSON struct {
	Description string            `json:"description"`
	Scopes      map[string]string `json:"scopes"`
}

Category represents the structure of each category in the JSON

type OutputScopes

type OutputScopes struct {
	Description string
	Scopes      []string
}

func (OutputScopes) PrintScopes

func (o OutputScopes) PrintScopes() string

type Permission

type Permission int

const (
	Invalid    Permission = iota
	Read       Permission = iota
	Write      Permission = iota
	FullAccess Permission = iota
)

func PermissionFromID

func PermissionFromID(id int) (Permission, error)

PermissionFromID converts an ID to its Permission enum

func PermissionFromString

func PermissionFromString(s string) (Permission, error)

PermissionFromString converts a string representation to its Permission enum

func (Permission) ToID

func (p Permission) ToID() (int, error)

ToID converts a Permission enum to its ID

func (Permission) ToString

func (p Permission) ToString() (string, error)

ToString converts a Permission enum to its string representation

type ScopeDataJSON

type ScopeDataJSON struct {
	Categories map[string]CategoryJSON `json:"categories"`
}

Data represents the overall JSON structure

type SecretInfo

type SecretInfo struct {
	StatusCode int
	ShopInfo   ShopInfoJSON
	Scopes     map[string]OutputScopes
}

func AnalyzePermissions

func AnalyzePermissions(cfg *config.Config, key string, storeURL string) (*SecretInfo, error)

type ShopInfoJSON

type ShopInfoJSON struct {
	Shop struct {
		Domain    string `json:"domain"`
		Name      string `json:"name"`
		Email     string `json:"email"`
		CreatedAt string `json:"created_at"`
	} `json:"shop"`
}