Class default

Hierarchy

Base
Commitments
Health
Items
Keys
- default

Index

Constructors

Methods

createApiKey createItem getCommitment getCommitmentVerification getHealth request updateItem

Constructors

constructor

new default(config?: {
apiEnv?: string;
apiKey?: string;
}): default
Parameters
- Optional config: {
  apiEnv?: string;
  apiKey?: string;
  }
  - Optional apiEnv?: string
  - Optional apiKey?: string
Returns default
Inherited from Base.constructor
- Defined in base.ts:7

Methods

createApiKey

createApiKey(key: {
    description?: string;
    refreshToken: string;
    ttl?: number;
}): Promise<{
    data: Record<string, any>;
    success: boolean;
}>
Parameters
- key: {
      description?: string;
      refreshToken: string;
      ttl?: number;
  }
  - Optional description?: string
  - refreshToken: string
  - Optional ttl?: number
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in keys/index.ts:5

createItem

createItem(item: Record<string, any>, args?: {
    skipCF?: boolean;
    skipOE?: boolean;
}): Promise<{
    data: Record<string, any>;
    success: boolean;
}>
Parameters
- item: Record<string, any>
- Optional args: {
  skipCF?: boolean;
  skipOE?: boolean;
  }
  - Optional skipCF?: boolean
  - Optional skipOE?: boolean
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in items/index.ts:5

getCommitment

getCommitment(id: string): Promise<{
data: Record<string, any>;
success: boolean;
}>
Parameters
- id: string
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in commitments/index.ts:5

getCommitmentVerification

getCommitmentVerification(id: string): Promise<{
data: Record<string, any>;
success: boolean;
}>
Parameters
- id: string
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in commitments/index.ts:12

getHealth

getHealth(): Promise<{
data: Record<string, any>;
success: boolean;
}>
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in health/index.ts:5

`Protected` request

request(resource: string, reqOptions?: RequestInit): Promise<{
data: Record<string, any>;
success: boolean;
}>
Parameters
- resource: string
- Optional reqOptions: RequestInit
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
Inherited from Base.request
- Defined in base.ts:12

updateItem

updateItem(id: string, item: Record<string, any>, args?: {
    skipCF?: boolean;
    skipOE?: boolean;
}): Promise<{
    data: Record<string, any>;
    success: boolean;
}>
Parameters
- id: string
- item: Record<string, any>
- Optional args: {
  skipCF?: boolean;
  skipOE?: boolean;
  }
  - Optional skipCF?: boolean
  - Optional skipOE?: boolean
Returns Promise<{
data: Record<string, any>;
success: boolean;
}>
- Defined in items/index.ts:29

Generated using TypeDoc v0.23.17