Hercules.API.Organizations

Documentation

data OrganizationsAPI auth f

Constructors

OrganizationsAPI

Fields

• findOrganizations :: f :- (Summary "Get all organizations user has admin access to" :> (auth :> ("api" :> ("organizations" :> Get '[JSON] [Organization]))))
• createOrganization :: f :- (Summary "Create a new organization" :> (auth :> ("api" :> ("organizations" :> (ReqBody '[JSON] CreateOrganization :> Post '[JSON] Organization)))))
• connectAccountToOrganization :: f :- (Summary "Connect an account to an organization" :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("accounts" :> (Capture "accountId" (Id Account) :> Post '[JSON] NoContent)))))))
• paymentLinkForOrganization :: f :- (Summary "Generate payment link for an organization" :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("paymentLink" :> Post '[JSON] PaymentLink))))))
• getOrganizationActiveUsers :: f :- (Summary "List the active users in an organization's accounts." :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("billing" :> Get '[JSON] BillingInfo))))))

Instances

Generic (OrganizationsAPI auth f)

Defined in Hercules.API.Organizations

Associated Types

type Rep (OrganizationsAPI auth f) :: Type -> Type

Methods

from :: OrganizationsAPI auth f -> Rep (OrganizationsAPI auth f) x

to :: Rep (OrganizationsAPI auth f) x -> OrganizationsAPI auth f

type Rep (OrganizationsAPI auth f)

Defined in Hercules.API.Organizations

type Rep (OrganizationsAPI auth f) = D1 ('MetaData "OrganizationsAPI" "Hercules.API.Organizations" "hercules-ci-api-0.7.2.1-inplace" 'False) (C1 ('MetaCons "OrganizationsAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "findOrganizations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Get all organizations user has admin access to" :> (auth :> ("api" :> ("organizations" :> Get '[JSON] [Organization])))))) :*: S1 ('MetaSel ('Just "createOrganization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Create a new organization" :> (auth :> ("api" :> ("organizations" :> (ReqBody '[JSON] CreateOrganization :> Post '[JSON] Organization)))))))) :*: (S1 ('MetaSel ('Just "connectAccountToOrganization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Connect an account to an organization" :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("accounts" :> (Capture "accountId" (Id Account) :> Post '[JSON] NoContent))))))))) :*: (S1 ('MetaSel ('Just "paymentLinkForOrganization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Generate payment link for an organization" :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("paymentLink" :> Post '[JSON] PaymentLink)))))))) :*: S1 ('MetaSel ('Just "getOrganizationActiveUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "List the active users in an organization's accounts." :> (auth :> ("api" :> ("organizations" :> (Capture "organizationId" (Id Organization) :> ("billing" :> Get '[JSON] BillingInfo))))))))))))