Class MyMiniFactoryClient

Hierarchy

MyMiniFactoryClient

Index

Constructors

constructor

new MyMiniFactoryClient(apiKey?: string): MyMiniFactoryClient
Parameters
- apiKey: string = ""
Returns MyMiniFactoryClient
- Defined in index.ts:15

Properties

`Protected` _apiKey

_apiKey: string = ""

`Protected` _fetch

_fetch: (<T>(this: MyMiniFactoryClient, method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH", url: string, params?: undefined | {
[k: string]: any;
}) => Promise<HttpResponse<T>>) = fetchIt

Type declaration

- <T>(this: MyMiniFactoryClient, method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH", url: string, params?: undefined | {
  [k: string]: any;
  }): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: MyMiniFactoryClient
  - method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
  - url: string
  - params: undefined | {
    [k: string]: any;
    } = undefined
  Returns Promise<HttpResponse<T>>

`Protected` _url

_url: string = "https://www.myminifactory.com/api/v2"

collection

collection: ((this: MyMiniFactoryClient, id: string) => Promise<HttpResponse<Collection>>) = Collections.collection

Type declaration

- (this: MyMiniFactoryClient, id: string): Promise<HttpResponse<Collection>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  Returns Promise<HttpResponse<Collection>>

collections

collections: ((this: MyMiniFactoryClient, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<Collection>>>) = Collections.collections

Type declaration

- (this: MyMiniFactoryClient, page?: number, perPage?: number): Promise<HttpResponse<Paginated<Collection>>>
- Parameters
  - this: MyMiniFactoryClient
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<Collection>>>

file

file: ((this: MyMiniFactoryClient, id: string) => Promise<HttpResponse<File>>) = Files.file

Type declaration

- (this: MyMiniFactoryClient, id: string): Promise<HttpResponse<File>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  Returns Promise<HttpResponse<File>>

me

me: ((this: MyMiniFactoryClient) => Promise<HttpResponse<User>>) = User.me

Type declaration

- (this: MyMiniFactoryClient): Promise<HttpResponse<User>>
- Parameters
  - this: MyMiniFactoryClient
  Returns Promise<HttpResponse<User>>

object

object: ((this: MyMiniFactoryClient, id: string) => Promise<HttpResponse<Object>>) = Objects.object

Type declaration

- (this: MyMiniFactoryClient, id: string): Promise<HttpResponse<Object>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  Returns Promise<HttpResponse<Object>>

objectFiles

objectFiles: ((this: MyMiniFactoryClient, id: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<File>>>) = Objects.objectFiles

Type declaration

- (this: MyMiniFactoryClient, id: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<File>>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<File>>>

objectPrints

objectPrints: ((this: MyMiniFactoryClient, id: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<Image>>>) = Objects.objectPrints

Type declaration

- (this: MyMiniFactoryClient, id: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<Image>>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<Image>>>

objectUploadStatus

objectUploadStatus: ((this: MyMiniFactoryClient, id: string) => Promise<HttpResponse<unknown>>) = Objects.objectUploadStatus

Type declaration

- (this: MyMiniFactoryClient, id: string): Promise<HttpResponse<unknown>>
- Parameters
  - this: MyMiniFactoryClient
  - id: string
  Returns Promise<HttpResponse<unknown>>

patchObjectMetadata

patchObjectMetadata: ((this: MyMiniFactoryClient, params: Partial<MetadataParams>) => Promise<HttpResponse<unknown>>) = Objects.patchObjectMetadata

Type declaration

- (this: MyMiniFactoryClient, params: Partial<MetadataParams>): Promise<HttpResponse<unknown>>
- Parameters
  - this: MyMiniFactoryClient
  - params: Partial<MetadataParams>
  Returns Promise<HttpResponse<unknown>>

search

search: ((this: MyMiniFactoryClient, searchParams: SearchParams) => Promise<HttpResponse<Paginated<Object>>>) = Search.search

Type declaration

- (this: MyMiniFactoryClient, searchParams: SearchParams): Promise<HttpResponse<Paginated<Object>>>
- Parameters
  - this: MyMiniFactoryClient
  - searchParams: SearchParams
  Returns Promise<HttpResponse<Paginated<Object>>>

uploadFile

uploadFile: ((this: MyMiniFactoryClient) => Promise<string>) = Files.uploadFile

Type declaration

- (this: MyMiniFactoryClient): Promise<string>
- Parameters
  - this: MyMiniFactoryClient
  Returns Promise<string>

uploadImage

uploadImage: ((this: MyMiniFactoryClient) => Promise<string>) = Files.uploadImage

Type declaration

- (this: MyMiniFactoryClient): Promise<string>
- Parameters
  - this: MyMiniFactoryClient
  Returns Promise<string>

uploadObjectMetadata

uploadObjectMetadata: ((this: MyMiniFactoryClient, params: MetadataParams) => Promise<HttpResponse<unknown>>) = Objects.uploadObjectMetadata

Type declaration

- (this: MyMiniFactoryClient, params: MetadataParams): Promise<HttpResponse<unknown>>
- Parameters
  - this: MyMiniFactoryClient
  - params: MetadataParams
  Returns Promise<HttpResponse<unknown>>

user

user: ((this: MyMiniFactoryClient, username: string) => Promise<HttpResponse<User>>) = User.user

Type declaration

- (this: MyMiniFactoryClient, username: string): Promise<HttpResponse<User>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  Returns Promise<HttpResponse<User>>

userCollection

userCollection: ((this: MyMiniFactoryClient, username: string, collectionSlug: string, page?: number, perPage?: number) => Promise<HttpResponse<Collection>>) = User.userCollection

Type declaration

- (this: MyMiniFactoryClient, username: string, collectionSlug: string, page?: number, perPage?: number): Promise<HttpResponse<Collection>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - collectionSlug: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Collection>>

userCollections

userCollections: ((this: MyMiniFactoryClient, username: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<Collection>>>) = User.userCollections

Type declaration

- (this: MyMiniFactoryClient, username: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<Collection>>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<Collection>>>

userFollowers

userFollowers: ((this: MyMiniFactoryClient, username: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<User>>>) = User.userFollowers

Type declaration

- (this: MyMiniFactoryClient, username: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<User>>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<User>>>

userFollowing

userFollowing: ((this: MyMiniFactoryClient, username: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<User>>>) = User.userFollowing

Type declaration

- (this: MyMiniFactoryClient, username: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<User>>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<User>>>

userLikedObjects

userLikedObjects: ((this: MyMiniFactoryClient, username: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<Object>>>) = User.userLikedObjects

Type declaration

- (this: MyMiniFactoryClient, username: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<Object>>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<Object>>>

userObjects

userObjects: ((this: MyMiniFactoryClient, username: string, page?: number, perPage?: number) => Promise<HttpResponse<Paginated<Object>>>) = User.userObjects

Type declaration

- (this: MyMiniFactoryClient, username: string, page?: number, perPage?: number): Promise<HttpResponse<Paginated<Object>>>
- Parameters
  - this: MyMiniFactoryClient
  - username: string
  - page: number = 1
  - perPage: number = 20
  Returns Promise<HttpResponse<Paginated<Object>>>

Methods

ping

ping(): string
Returns string
- Defined in index.ts:20

Class MyMiniFactoryClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKey: string = ""

Returns MyMiniFactoryClient

Properties

Protected _apiKey

Protected _fetch

Type declaration

Type Parameters

T

Parameters

this: MyMiniFactoryClient

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

url: string

params: undefined | { [k: string]: any; } = undefined

Returns Promise<HttpResponse<T>>

Protected _url

categories

Type declaration

Parameters

this: MyMiniFactoryClient

page: number = 1

perPage: number = 20

Returns Promise<HttpResponse<Paginated<Category>>>

category

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

Returns Promise<HttpResponse<Category>>

collection

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

Returns Promise<HttpResponse<Collection>>

collections

Type declaration

Parameters

this: MyMiniFactoryClient

page: number = 1

perPage: number = 20

Returns Promise<HttpResponse<Paginated<Collection>>>

file

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

Returns Promise<HttpResponse<File>>

me

Type declaration

Parameters

this: MyMiniFactoryClient

Returns Promise<HttpResponse<User>>

object

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

Returns Promise<HttpResponse<Object>>

objectFiles

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

page: number = 1

perPage: number = 20

Returns Promise<HttpResponse<Paginated<File>>>

objectPrints

Type declaration

Parameters

this: MyMiniFactoryClient

id: string

`Protected` _apiKey

`Protected` _fetch

params: undefined | {
[k: string]: any;
} = undefined

`Protected` _url