@voucherify/sdk 3.0.0 → 3.0.2

package/dist/types/ApiClient.d.ts

@@ -0,0 +1,209 @@
+export default ApiClient;
+/**
+* @module ApiClient
+* @version 3.0.2
+*/
+/**
+* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
+* application to use this class directly - the *Api and model classes provide the public API for the service. The
+* contents of this file should be regarded as internal but are documented for completeness.
+* @alias module:ApiClient
+* @class
+*/
+declare class ApiClient {
+    /**
+    * Returns a boolean indicating if the parameter could be JSON.stringified
+    * @param str The actual parameter
+    * @returns {Boolean} Flag indicating if <code>param</code> can be JSON.stringified
+    */
+    static canBeJsonified(str: any): boolean;
+    /**
+    * Parses an ISO-8601 string representation or epoch representation of a date value.
+    * @param {string} str The date value as a string.
+    * @returns {Date} The parsed date object.
+    */
+    static parseDate(str: string): Date;
+    /**
+    * Converts a value to the specified type.
+    * @param {(String|Object)} data The data to convert, as a string or object.
+    * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
+    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+    * all properties on <code>data<code> will be converted to this type.
+    * @returns An instance of the specified type or null or undefined if data is null or undefined.
+    */
+    static convertToType(data: (string | any), type: (string | Array<string> | any | Function)): any;
+    /**
+    * Constructs a new map or array model from REST data.
+    * @param data {Object|Array} The REST data.
+    * @param obj {Object|Array} The target object or array.
+    */
+    static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * Overrides the default value set in spec file if present
+     * @param {string} basePath
+     */
+    constructor(basePath?: string);
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * @type {string}
+     * @default https://api.voucherify.io
+     */
+    basePath: string;
+    /**
+     * The authentication methods to be included for all API calls.
+     * @type {Array.<String>}
+     */
+    authentications: Array<string>;
+    /**
+         * The default HTTP headers to be included for all API calls.
+         * @type {Array.<String>}
+         * @default {}
+         */
+    defaultHeaders: Array<string>;
+    /**
+     * The default HTTP timeout for all API calls.
+     * @type {number}
+     * @default 60000
+     */
+    timeout: number;
+    /**
+     * If set to false an additional timestamp parameter is added to all API GET calls to
+     * prevent browser caching
+     * @type {Boolean}
+     * @default true
+     */
+    cache: boolean;
+    /**
+         * If set to true, the client will save the cookies from each server
+         * response, and return them in the next request.
+         * @default false
+         */
+    enableCookies: boolean;
+    agent: any;
+    requestAgent: any;
+    plugins: any;
+    /**
+    * Returns a string representation for an actual parameter.
+    * @param param The actual parameter.
+    * @returns {string} The string representation of <code>param</code>.
+    */
+    paramToString(param: any): string;
+    /**
+     * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
+     * NOTE: query parameters are not handled here.
+     * @param {string} path The path to append to the base URL.
+     * @param {object} pathParams The parameter values to append.
+     * @param {string} apiBasePath Base path defined in the path, operation level to override the default one
+     * @returns {string} The encoded path with parameter values substituted.
+     */
+    buildUrl(path: string, pathParams: object, apiBasePath: string): string;
+    /**
+    * Checks whether the given content type represents JSON.<br>
+    * JSON content type examples:<br>
+    * <ul>
+    * <li>application/json</li>
+    * <li>application/json; charset=UTF8</li>
+    * <li>APPLICATION/JSON</li>
+    * </ul>
+    * @param {string} contentType The MIME content type to check.
+    * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
+    */
+    isJsonMime(contentType: string): boolean;
+    /**
+    * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+    * @param {Array.<String>} contentTypes
+    * @returns {string} The chosen content type, preferring JSON.
+    */
+    jsonPreferredMime(contentTypes: Array<string>): string;
+    /**
+    * Checks whether the given parameter value represents file-like content.
+    * @param param The parameter to check.
+    * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
+    */
+    isFileParam(param: any): boolean;
+    /**
+    * Normalizes parameter values:
+    * <ul>
+    * <li>remove nils</li>
+    * <li>keep files and arrays</li>
+    * <li>format to string with `paramToString` for other cases</li>
+    * </ul>
+    * @param {Object.<String, Object>} params The parameters as object properties.
+    * @returns {Object.<String, Object>} normalized parameters.
+    */
+    normalizeParams(params: any): any;
+    /**
+    * Applies authentication headers to the request.
+    * @param {object} request The request object created by a <code>superagent()</code> call.
+    * @param {Array.<String>} authNames An array of authentication method names.
+    */
+    applyAuthToRequest(request: object, authNames: Array<string>): void;
+    /**
+     * Deserializes an HTTP response body into a value of the specified type.
+     * @param {object} response A SuperAgent response object.
+     * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
+     * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+     * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+     * all properties on <code>data<code> will be converted to this type.
+     * @returns A value of the specified type.
+     */
+    deserialize(response: object, returnType: (string | Array<string> | any | Function)): any;
+    /**
+     * Callback function to receive the result of the operation.
+     * @callback module:ApiClient~callApiCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {*} [data] Deserialized data if successful.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Invokes the REST service using the supplied settings and parameters.
+     * @param {string} path The base URL to invoke.
+     * @param {string} httpMethod The HTTP method to use.
+     * @param {Object.<String, String>} pathParams A map of path parameters and their values.
+     * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
+     * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
+     * @param {Object.<String, Object>} formParams A map of form parameters and their values.
+     * @param {object} bodyParam The value to pass as the request body.
+     * @param {Array.<String>} authNames An array of authentication type names.
+     * @param {Array.<String>} contentTypes An array of request MIME types.
+     * @param {Array.<String>} accepts An array of acceptable response MIME types.
+     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
+     * constructor for a complex type.
+     * @param {string} apiBasePath base path defined in the operation/path level to override the default one
+     * @param {module:ApiClient~callApiCallback} callback The callback function.
+     * @returns {Object} The SuperAgent request object.
+     */
+    callApi(path: string, httpMethod: string, pathParams: any, queryParams: any, headerParams: any, formParams: any, bodyParam: object, authNames: Array<string>, contentTypes: Array<string>, accepts: Array<string>, returnType: (string | any[] | ObjectFunction), apiBasePath: string, callback: any): any;
+    /**
+      * Gets an array of host settings
+      * @returns An array of host settings
+      */
+    hostSettings(): {
+        url: string;
+        description: string;
+        variables: {
+            cluster: {
+                description: string;
+                default_value: string;
+                enum_values: string[];
+            };
+        };
+    }[];
+    getBasePathFromSettings(index: any, variables?: {}): string;
+}
+declare namespace ApiClient {
+    namespace CollectionFormatEnum {
+        let CSV: string;
+        let SSV: string;
+        let TSV: string;
+        let PIPES: string;
+        let MULTI: string;
+    }
+    /**
+     * *
+     */
+    type CollectionFormatEnum = string;
+    let instance: any;
+}

package/dist/types/api/AsyncActionsApi.d.ts

@@ -0,0 +1,56 @@
+/**
+* AsyncActions service.
+* @module api/AsyncActionsApi
+* @version 3.0.2
+*/
+export default class AsyncActionsApi {
+    /**
+    * Constructs a new AsyncActionsApi.
+    * @alias AsyncActionsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the getAsyncAction operation.
+     * @callback getAsyncActionCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {AsyncActionGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Async Action
+     * Check the result of a scheduled asynchronous operation.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).
+     * @param {String} asyncActionId Unique ID of the asynchronous operation.
+     * @param {getAsyncActionCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link AsyncActionGetResponseBody}
+     * @returns {Promise<(AsyncActionGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `AsyncActionGetResponseBody` object or with `undefined`.
+     */
+    getAsyncAction(asyncActionId: string, callback?: (error: Error | null, data?: AsyncActionGetResponseBody, response?: any) => any): Promise<(AsyncActionGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listAsyncActions operation.
+     * @callback listAsyncActionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {AsyncActionsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Async Actions
+     * Track asynchronous operations scheduled in your project.   The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).
+     * @param {{
+        limit?: Number,
+        endDate?: Date,
+     }} [opts] Optional parameters
+     * @param {listAsyncActionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link AsyncActionsListResponseBody}
+     * @returns {Promise<(AsyncActionsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `AsyncActionsListResponseBody` object or with `undefined`.
+     */
+    listAsyncActions(opts?: {
+        limit?: number;
+        endDate?: Date;
+    }, callback?: (error: Error | null, data?: AsyncActionsListResponseBody, response?: any) => any): Promise<(AsyncActionsListResponseBody | undefined)>;
+}
+import AsyncActionGetResponseBody from '../model/AsyncActionGetResponseBody';
+import AsyncActionsListResponseBody from '../model/AsyncActionsListResponseBody';

package/dist/types/api/BinApi.d.ts

@@ -0,0 +1,60 @@
+/**
+* Bin service.
+* @module api/BinApi
+* @version 3.0.2
+*/
+export default class BinApi {
+    /**
+    * Constructs a new BinApi.
+    * @alias BinApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the deleteBinEntry operation.
+     * @callback deleteBinEntryCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Bin Entry
+     * Deletes permanently a bin entry with a given ID.The following resources can be moved to the bin and permanently deleted: - campaigns - vouchers - products - SKUs To use this endpoint and delete a given resource type, you must have the following permissions: - vouchers.delete to delete a voucher, - campaigns.delete to delete a campaign, - products.delete to delete a product or SKU.
+     * @param {String} binEntryId Provide the unique identifier of the bin entry.
+     * @param {deleteBinEntryCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    deleteBinEntry(binEntryId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the listBinEntries operation.
+     * @callback listBinEntriesCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {TrashBinListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Bin Entries
+     * Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
+     * @param {{
+        limit?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListBin, "prototype" | "constructFromObject">,
+        startingAfterId?: String,
+        filters?: ParameterFiltersListBin,
+     }} [opts] Optional parameters
+     * @param {listBinEntriesCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link TrashBinListResponseBody}
+     * @returns {Promise<(TrashBinListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `TrashBinListResponseBody` object or with `undefined`.
+     */
+    listBinEntries(opts?: {
+        limit?: number;
+        order?: Exclude<keyof typeof ParameterOrderListBin, "prototype" | "constructFromObject">;
+        startingAfterId?: string;
+        filters?: ParameterFiltersListBin;
+    }, callback?: (error: Error | null, data?: TrashBinListResponseBody, response?: any) => any): Promise<(TrashBinListResponseBody | undefined)>;
+}
+import ParameterOrderListBin from '../model/ParameterOrderListBin';
+import ParameterFiltersListBin from '../model/ParameterFiltersListBin';
+import TrashBinListResponseBody from '../model/TrashBinListResponseBody';