@magda/typescript-common 2.3.3 → 3.0.0-alpha.1

package/dist/generated/registry/api.d.ts

@@ -9,9 +9,6 @@
  * https://github.com/swagger-api/swagger-codegen.git
  * Do not edit the class manually.
  */
-/// <reference types="node" />
-import request = require('request');
-import http = require('http');
 export declare class ApiError {
     'message': string;
 }
@@ -46,7 +43,7 @@ export declare class DeleteResult {
 /**
 * The type of a registry modification event.
 */
-export declare type EventType = 'CreateRecord' | 'CreateAspectDefinition' | 'CreateRecordAspect' | 'PatchRecord' | 'PatchAspectDefinition' | 'PatchRecordAspect' | 'DeleteRecord' | 'DeleteAspectDefinition' | 'DeleteRecordAspect';
+export type EventType = 'CreateRecord' | 'CreateAspectDefinition' | 'CreateRecordAspect' | 'PatchRecord' | 'PatchAspectDefinition' | 'PatchRecordAspect' | 'DeleteRecord' | 'DeleteAspectDefinition' | 'DeleteRecordAspect';
 /**
 * A page of events.
 */
@@ -195,42 +192,64 @@ export declare class WebHookConfig {
     'includeAspectDefinitions': any;
     'dereference': any;
 }
+interface GenericRecord {
+    [key: string]: any;
+}
+export interface RequestOptions extends RequestInit {
+    qs?: GenericRecord;
+    json?: boolean;
+    body?: any;
+    uri?: string;
+    formData?: {
+        [key: string]: any;
+    };
+    form?: {
+        [key: string]: any;
+    } | string;
+    encoding?: null | string;
+}
+export declare function setRequestOptionsHeader(requestOptions: RequestOptions, headerName: string, headerValue: string): void;
+export declare const isPlainObj: (value: any) => boolean;
+export declare const isTextMimeType: (contentType: string) => boolean;
+export declare const isNotEmpty: (val: any) => boolean;
+export declare function fetchWithRequestOptions(requestOptions: RequestOptions): Promise<{
+    response: Response;
+    body: any;
+}>;
 export interface Authentication {
     /**
-    * Apply authentication settings to header and query params.
-    */
-    applyToRequest(requestOptions: request.Options): void;
+     * Apply authentication settings to header and query params.
+     */
+    applyToRequest(fetchOptions: RequestOptions): void;
 }
 export declare class HttpBasicAuth implements Authentication {
     username: string;
     password: string;
-    applyToRequest(requestOptions: request.Options): void;
+    applyToRequest(requestOptions: RequestOptions): void;
 }
 export declare class ApiKeyAuth implements Authentication {
     private location;
     private paramName;
     apiKey: string;
     constructor(location: string, paramName: string);
-    applyToRequest(requestOptions: request.Options): void;
+    applyToRequest(requestOptions: RequestOptions): void;
 }
 export declare class OAuth implements Authentication {
     accessToken: string;
-    applyToRequest(requestOptions: request.Options): void;
+    applyToRequest(requestOptions: RequestOptions): void;
 }
 export declare class VoidAuth implements Authentication {
     username: string;
     password: string;
-    applyToRequest(_: request.Options): void;
+    applyToRequest(_: RequestOptions): void;
 }
 export declare enum AspectDefinitionsApiApiKeys {
 }
 export declare class AspectDefinitionsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: AspectDefinitionsApiApiKeys, value: string): void;
     /**
      * Create a new aspect
@@ -240,7 +259,7 @@ export declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     create(xMagdaTenantId: number, aspect: AspectDefinition, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -250,7 +269,7 @@ export declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAll(xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<AspectDefinition>;
     }>;
     /**
@@ -261,7 +280,7 @@ export declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(xMagdaTenantId: number, id: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -273,7 +292,7 @@ export declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchById(xMagdaTenantId: number, id: string, aspectPatch: Array<Operation>, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -285,7 +304,7 @@ export declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     putById(xMagdaTenantId: number, id: string, aspect: AspectDefinition, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
 }
@@ -294,10 +313,8 @@ export declare enum RecordAspectsApiApiKeys {
 export declare class RecordAspectsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordAspectsApiApiKeys, value: string): void;
     /**
      * Delete a record aspect by ID
@@ -308,7 +325,7 @@ export declare class RecordAspectsApi {
      * @param xMagdaTenantId 0
      */
     deleteById(recordId: string, aspectId: string, xMagdaSession: string, xMagdaTenantId: number): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -323,7 +340,7 @@ export declare class RecordAspectsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAspects(xMagdaTenantId: number, recordId: string, keyword?: string, aspectIdOnly?: boolean, start?: number, limit?: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -335,7 +352,7 @@ export declare class RecordAspectsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAspectsCount(xMagdaTenantId: number, recordId: string, keyword?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: CountResponse;
     }>;
     /**
@@ -347,7 +364,7 @@ export declare class RecordAspectsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(xMagdaTenantId: number, recordId: string, aspectId: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
     /**
@@ -360,7 +377,7 @@ export declare class RecordAspectsApi {
      * @param xMagdaTenantId 0
      */
     patchById(recordId: string, aspectId: string, aspectPatch: Array<Operation>, xMagdaSession: string, xMagdaTenantId: number): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
     /**
@@ -374,7 +391,7 @@ export declare class RecordAspectsApi {
      * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
      */
     putById(recordId: string, aspectId: string, aspect: any, xMagdaSession: string, xMagdaTenantId: number, merge?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
 }
@@ -383,10 +400,8 @@ export declare enum RecordHistoryApiApiKeys {
 export declare class RecordHistoryApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordHistoryApiApiKeys, value: string): void;
     /**
      * Get a list of all events affecting this record
@@ -402,7 +417,7 @@ export declare class RecordHistoryApi {
      * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
      */
     history(xMagdaTenantId: number, recordId: string, xMagdaSession: string, pageToken?: string, start?: number, limit?: number, aspect?: Array<string>, dereference?: boolean, reversePageTokenOrder?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: EventsPage;
     }>;
     /**
@@ -413,7 +428,7 @@ export declare class RecordHistoryApi {
      * @param eventId The ID of the last event to be applied to the record.  The event with this ID need not actually apply to the record, in which case that last event prior to this even that does apply will be used.
      */
     version(xMagdaTenantId: number, recordId: string, eventId: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
 }
@@ -422,10 +437,8 @@ export declare enum RecordsApiApiKeys {
 export declare class RecordsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordsApiApiKeys, value: string): void;
     /**
      * Create a new record
@@ -435,7 +448,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     create(xMagdaTenantId: number, record: Record, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
     /**
@@ -446,7 +459,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteById(xMagdaTenantId: number, recordId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -458,7 +471,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteRecordsAspectArrayItems(xMagdaTenantId: number, aspectId: string, requestData: DeleteRecordsAspectArrayItemsRequest, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -481,7 +494,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAll(xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, start?: number, limit?: number, dereference?: boolean, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<Record>;
     }>;
     /**
@@ -496,7 +509,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<RecordSummary>;
     }>;
     /**
@@ -510,7 +523,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(id: string, xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
     /**
@@ -521,7 +534,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
     /**
@@ -532,7 +545,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getByIdSummary(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: RecordSummary;
     }>;
     /**
@@ -546,7 +559,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getCount(xMagdaTenantId: number, aspect?: Array<string>, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: CountResponse;
     }>;
     /**
@@ -558,7 +571,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getPageTokens(xMagdaTenantId: number, aspect?: Array<string>, limit?: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<string>;
     }>;
     /**
@@ -570,7 +583,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchById(xMagdaTenantId: number, id: string, recordPatch: Array<Operation>, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
     /**
@@ -581,7 +594,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchRecords(xMagdaTenantId: number, requestData: PatchRecordsRequest, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -594,7 +607,7 @@ export declare class RecordsApi {
      * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
      */
     putById(xMagdaTenantId: number, id: string, record: Record, xMagdaSession: string, merge?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record;
     }>;
     /**
@@ -607,7 +620,7 @@ export declare class RecordsApi {
      * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
      */
     putRecordsAspect(xMagdaTenantId: number, aspectId: string, requestData: PutRecordsAspectRequest, xMagdaSession: string, merge?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -619,7 +632,7 @@ export declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     trimBySourceTag(xMagdaTenantId: number, sourceTagToPreserve: string, sourceId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: MultipleDeleteResult;
     }>;
 }
@@ -628,10 +641,8 @@ export declare enum WebHooksApiApiKeys {
 export declare class WebHooksApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: WebHooksApiApiKeys, value: string): void;
     /**
      * Acknowledge a previously-deferred web hook
@@ -641,7 +652,7 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     ack(id: string, acknowledgement: WebHookAcknowledgement, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHookAcknowledgementResponse;
     }>;
     /**
@@ -651,7 +662,7 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     create(hook: WebHook, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
     /**
@@ -661,7 +672,7 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteById(hookId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -670,7 +681,7 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     getAll(xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<WebHook>;
     }>;
     /**
@@ -680,7 +691,7 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(id: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
     /**
@@ -691,7 +702,8 @@ export declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     putById(id: string, hook: WebHook, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
 }
+export {};