Interface WKStudyMaterialRequests

Types of Study Material Requests available in the WaniKani API.

interface WKStudyMaterialRequests {
    create: ((payload: WKStudyMaterialCreatePayload, options?: WKRequestPostPutOptions) => WKRequest);
    get: ((idOrParams?: number | WKStudyMaterialParameters, options?: WKRequestGetOptions) => WKRequest);
    update: ((id: number, payload: Partial<WKStudyMaterialBaseData>, options?: WKRequestPostPutOptions) => WKRequest);
}

Index

Properties

create get update

Properties

create

create: ((payload: WKStudyMaterialCreatePayload, options?: WKRequestPostPutOptions) => WKRequest)

Create a new Study Material for a given Subject via the WaniKani API.

Type declaration

- (payload, options?): WKRequest
- Parameters
  - payload: WKStudyMaterialCreatePayload
    The payload to send when creating the new Study Material.
  - Optionaloptions: WKRequestPostPutOptions
    Options for making POST requests to the API.
  Returns WKRequest
  A Create Study Material Request usabile in any HTTP API/Library.

get

get: ((idOrParams?: number | WKStudyMaterialParameters, options?: WKRequestGetOptions) => WKRequest)

Get a Study Material or Study Material Collection from the WaniKani API.

Type declaration

- (idOrParams?, options?): WKRequest
- Parameters
  - OptionalidOrParams: number | WKStudyMaterialParameters
    The Study Material ID for individual Study Materials, or parameters for Study Material Collections.
  - Optionaloptions: WKRequestGetOptions
    Options for making GET requests to the API.
  Returns WKRequest
  A Get Study Material(s) Request usabile in any HTTP API/Library.

update

update: ((id: number, payload: Partial<WKStudyMaterialBaseData>, options?: WKRequestPostPutOptions) => WKRequest)

Update a Study Material for a given Subject.

Type declaration

- (id, payload, options?): WKRequest
- Parameters
  - id: number
    The Study Material ID to update.
  - payload: Partial<WKStudyMaterialBaseData>
    The payload to send when updating the Study Material.
  - Optionaloptions: WKRequestPostPutOptions
    Options for making PUT requests to the API.
  Returns WKRequest
  An Update Study Material Request usabile in any HTTP API/Library.