dynamics-web-api-callbacks.d.ts

// Type definitions for dynamics-web-api-callbacks v1.6.0
// Project: https://github.com/AleksandrRogov/DynamicsWebApi
// Definitions by: Aleksandr Rogov https://github.com/AleksandrRogov/

declare class DynamicsWebApi {
    /**
     * DynamicsWebApi constructor
     * @param config - DynamicsWebApi configuration
     */
    constructor(config?: DynamicsWebApi.Config);
    /**
     * Sets DynamicsWebApi configuration parameters.
     *
     * @param config - configuration object
     * @example
        dynamicsWebApi.setConfig({ webApiVersion: '9.0' });
     */
    setConfig(config: DynamicsWebApi.Config): void;
    /**
     * Sends an asynchronous request to create a new record.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @example
        *var lead = {
        *    subject: "Test WebAPI",
        *    firstname: "Test",
        *    lastname: "WebAPI",
        *    jobtitle: "Title"
        *};
        *
        *var request = {
        *    entity: lead,
        *    collection: "leads",
        *    returnRepresentation: true
        *}
        *
        *dynamicsWebApi.createRequest(request, function (response) {
        *}, function (error) {
        *});
     */
    createRequest(request: DynamicsWebApi.CreateRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to create a new record.
     *
     * @param object - A JavaScript object valid for create operations.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param prefer - Sets a Prefer header value. For example: ['retrun=representation', 'odata.include-annotations="*"'].
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     * @example
        *var lead = {
        *    subject: "Test WebAPI",
        *    firstname: "Test",
        *    lastname: "WebAPI",
        *    jobtitle: "Title"
        *};
        *
        *dynamicsWebApi.create(lead, "leads", function (id) {
        *}, function (error) {
        *});
     */
    create(object: Object, collection: string, successCallback: Function, errorCallback: Function, prefer?: string | string[], select?: string[]): void;
    /**
     * Sends an asynchronous request to update a record.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    updateRequest(request: DynamicsWebApi.UpdateRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to update a record.
     *
     * @param key - A String representing the GUID value or Alternate Key(s) for the record to update.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param object - A JavaScript object valid for update operations.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param prefer - If set to "return=representation" the function will return an updated object
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     */
    update(key: string, collection: string, object: Object, successCallback: Function, errorCallback: Function, prefer?: string | string[], select?: string[]): void;
    /**
     * Sends an asynchronous request to update a single value in the record.
     *
     * @param key - A String representing the GUID value or Alternate Key(s) for the record to update.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param keyValuePair - keyValuePair object with a logical name of the field as a key and a value to update with. Example: {subject: "Update Record"}
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param prefer - If set to "return=representation" the function will return an updated object
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     */
    updateSingleProperty(key: string, collection: string, keyValuePair: Object, successCallback: Function, errorCallback: Function, prefer?: string | string[], select?: string[]): void;
    /**
     * Sends an asynchronous request to delete a record.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    deleteRequest(request: DynamicsWebApi.DeleteRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to delete a record.
     *
     * @param key - A String representing the GUID value or Alternate Key(s) for the record to delete.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param propertyName - The name of the property which needs to be emptied. Instead of removing a whole record only the specified property will be cleared.
     */
    deleteRecord(key: string, collection: string, successCallback: Function, errorCallback: Function, propertyName?: string): void;
    /**
     * Sends an asynchronous request to retrieve a record.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    retrieveRequest(request: DynamicsWebApi.RetrieveRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to retrieve a record.
     *
     * @param key - A String representing the GUID value or Alternate Key(s) for the record to retrieve.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     * @param expand - A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.
     */
    retrieve(key: string, collection: string, successCallback: Function, errorCallback: Function, select?: string[], expand?: DynamicsWebApi.Expand[]): void;
    /**
     * Sends an asynchronous request to upsert a record.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    upsertRequest(request: DynamicsWebApi.UpsertRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to upsert a record.
     *
     * @param key - A String representing the GUID value or Alternate Key(s) for the record to upsert.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param object - A JavaScript object valid for update operations.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param prefer - If set to "return=representation" the function will return an updated object
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     */
    upsert(key: string, collection: string, object: Object, successCallback: Function, errorCallback: Function, prefer?: string | string[], select?: string[]): void;
    /**
     * Sends an asynchronous request to count records. IMPORTANT! The count value does not represent the total number of entities in the system. It is limited by the maximum number of entities that can be returned. Returns: Number
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param filter - Use the $filter system query option to set criteria for which entities will be returned.
     */
    count(collection: string, successCallback: Function, errorCallback: Function, filter?: string): void;
    /**
     * Sends an asynchronous request to count records. Returns: Number
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param filter - Use the $filter system query option to set criteria for which entities will be returned.
     * @param select - An Array representing the $select Query Option to control which attributes will be returned.
     */
    countAll(collection: string, successCallback: Function, errorCallback: Function, filter?: string, select?: string[]): void;
    /**
     * Sends an asynchronous request to retrieve records.
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param filter - Use the $filter system query option to set criteria for which entities will be returned.
     * @param oDataLink - Use this parameter to pass @odata.nextLink or @odata.deltaLink to return a necessary response. Pass null to retrieveMultipleOptions.
     */
    retrieveMultiple(collection: string, successCallback: Function, errorCallback: Function, select?: string[], filter?: string, oDataLink?: string): void;
    /**
    * Sends an asynchronous request to retrieve all records.
    *
    * @param collection - The name of the Entity Collection or Entity Logical name.
    * @param successCallback - The function that will be passed through and be called by a successful response.
    * @param errorCallback - The function that will be passed through and be called by a failed response.
    * @param select - Use the $select system query option to limit the properties returned.
    * @param filter - Use the $filter system query option to set criteria for which entities will be returned.
    */
    retrieveAll(collection: string, successCallback: Function, errorCallback: Function, select?: string[], filter?: string): void;
    /**
     * Sends an asynchronous request to retrieve records.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param oDataLink - Use this parameter to pass @odata.nextLink or @odata.deltaLink to return a necessary response. Pass null to retrieveMultipleOptions.
     */
    retrieveMultipleRequest(request: DynamicsWebApi.RetrieveMultipleRequest, successCallback: Function, errorCallback: Function, oDataLink?: string): void;
    /**
     * Sends an asynchronous request to retrieve all records.
     *
     * @param request - An object that represents all possible options for a current request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    retrieveAllRequest(request: DynamicsWebApi.RetrieveMultipleRequest, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to count records. Returns: DWA.Types.FetchXmlResponse
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param fetchXml - FetchXML is a proprietary query language that provides capabilities to perform aggregation.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param includeAnnotations - Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
     * @param pageNumber - Page number.
     * @param pagingCookie - Paging cookie. For retrieving the first page, pagingCookie should be null.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeFetchXml(collection: string, fetchXml: string, successCallback: Function, errorCallback: Function, includeAnnotations?: string, pageNumber?: number, pagingCookie?: string, impersonateUserId?: string): void;
    /**
     * Sends an asynchronous request to count records. Returns: DWA.Types.FetchXmlResponse
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param fetchXml - FetchXML is a proprietary query language that provides capabilities to perform aggregation.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param includeAnnotations - Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
     * @param pageNumber - Page number.
     * @param pagingCookie - Paging cookie. For retrieving the first page, pagingCookie should be null.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    fetch(collection: string, fetchXml: string, successCallback: Function, errorCallback: Function, includeAnnotations?: string, pageNumber?: number, pagingCookie?: string, impersonateUserId?: string): void;
    /**
     * Sends an asynchronous request to execute FetchXml to retrieve all records.
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param fetchXml - FetchXML is a proprietary query language that provides capabilities to perform aggregation.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param includeAnnotations - Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeFetchXmlAll(collection: string, fetchXml: string, successCallback: Function, errorCallback: Function, includeAnnotations?: string, impersonateUserId?: string): void;
    /**
     * Sends an asynchronous request to execute FetchXml to retrieve all records.
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param fetchXml - FetchXML is a proprietary query language that provides capabilities to perform aggregation.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param includeAnnotations - Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    fetchAll(collection: string, fetchXml: string, successCallback: Function, errorCallback: Function, includeAnnotations?: string, impersonateUserId?: string): void;
    /**
     * Associate for a collection-valued navigation property. (1:N or N:N)
     *
     * @param collection - Primary Entity Collection name or Entity Name.
     * @param primaryKey - Primary entity record id.
     * @param relationshipName - Relationship name.
     * @param relatedCollection - Related Entity Collection name or Entity Name.
     * @param relatedKey - Related entity record id.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    associate(collection: string, primaryKey: string, relationshipName: string, relatedCollection: string, relatedKey: string, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
     * Disassociate for a collection-valued navigation property.
     *
     * @param collection - Primary Entity Collection name or Entity Name.
     * @param primaryKey - Primary entity record id.
     * @param relationshipName - Relationship name.
     * @param relatedKey - Related entity record id.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    disassociate(collection: string, primaryKey: string, relationshipName: string, relatedKey: string, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
    * Associate for a single-valued navigation property. (1:N)
    *
    * @param collection - The name of the Entity Collection or Entity Logical name.
    * @param key - Entity record Id that contains an attribute.
    * @param singleValuedNavigationPropertyName - Single-valued navigation property name (usually it's a Schema Name of the lookup attribute).
    * @param relatedCollection - Related collection name that the lookup (attribute) points to.
    * @param relatedKey - Related entity record id that needs to be associated.
    * @param successCallback - The function that will be passed through and be called by a successful response.
    * @param errorCallback - The function that will be passed through and be called by a failed response.
    * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
    */
    associateSingleValued(collection: string, key: string, singleValuedNavigationPropertyName: string, relatedCollection: string, relatedKey: string, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
     * Removes a reference to an entity for a single-valued navigation property. (1:N)
     *
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param key - Entity record Id that contains an attribute.
     * @param singleValuedNavigationPropertyName - Single-valued navigation property name (usually it's a Schema Name of the lookup attribute).
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    disassociateSingleValued(collection: string, key: string, singleValuedNavigationPropertyName: string, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
     * Executes an unbound function (not bound to a particular entity record)
     *
     * @param functionName - The name of the function.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param parameters - Function's input parameters. Example: { param1: "test", param2: 3 }.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeUnboundFunction(functionName: string, successCallback: Function, errorCallback: Function, parameters?: Object, impersonateUserId?: string): void;
    /**
     * Executes a bound function
     *
     * @param id - A String representing the GUID value for the record.
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param functionName - The name of the function.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param parameters - Function's input parameters. Example: { param1: "test", param2: 3 }.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeBoundFunction(id: string, collection: string, functionName: string, successCallback: Function, errorCallback: Function, parameters?: Object, impersonateUserId?: string): void;
    /**
     * Executes an unbound Web API action (not bound to a particular entity record)
     *
     * @param actionName - The name of the Web API action.
     * @param requestObject - Action request body object.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeUnboundAction(actionName: string, requestObject: Object, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
     * Executes a bound Web API action (bound to a particular entity record)
     *
     * @param id - A String representing the GUID value for the record (pass "null" for an optional parameter)
     * @param collection - The name of the Entity Collection or Entity Logical name.
     * @param actionName - The name of the Web API action.
     * @param requestObject - Action request body object.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param impersonateUserId - A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
     */
    executeBoundAction(id: string, collection: string, actionName: string, requestObject: Object, successCallback: Function, errorCallback: Function, impersonateUserId?: string): void;
    /**
     * Sends an asynchronous request to create an entity definition.
     *
     * @param entityDefinition - Entity Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    createEntity(entityDefinition: Object, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to update an entity definition.
     *
     * @param entityDefinition - Entity Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param mergeLabels - Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.
     */
    updateEntity(entityDefinition: Object, successCallback: Function, errorCallback: Function, mergeLabels?: boolean): void;
    /**
     * Sends an asynchronous request to retrieve a specific entity definition.
     *
     * @param entityKey - The Entity MetadataId or Alternate Key (such as LogicalName).
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param expand - A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.
     */
    retrieveEntity(entityKey: string, successCallback: Function, errorCallback: Function, select?: string[], expand?: DynamicsWebApi.Expand[]): void;
    /**
     * Sends an asynchronous request to retrieve entity definitions.
     *
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param filter - Use the $filter system query option to set criteria for which entity definitions will be returned.
     */
    retrieveEntities(successCallback: Function, errorCallback: Function, select?: string[], filter?: string): void;
    /**
     * Sends an asynchronous request to create an attribute.
     *
     * @param entityKey - The Entity MetadataId or Alternate Key (such as LogicalName).
     * @param attributeDefinition - Object that describes the attribute.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    createAttribute(entityKey: string, attributeDefinition: Object, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to update an attribute.
     *
     * @param entityKey - The Entity MetadataId or Alternate Key (such as LogicalName).
     * @param attributeDefinition - Object that describes the attribute.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param attributeType - Use this parameter to cast the Attribute to a specific type.
     * @param mergeLabels - Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.
     */
    updateAttribute(entityKey: string, attributeDefinition: Object, successCallback: Function, errorCallback: Function, attributeType?: string, mergeLabels?: boolean): void;
    /**
     * Sends an asynchronous request to retrieve attribute metadata for a specified entity definition.
     *
     * @param entityKey - The Entity MetadataId or Alternate Key (such as LogicalName).
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param attributeType - Use this parameter to cast the Attributes to a specific type.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param filter - Use the $filter system query option to set criteria for which attribute definitions will be returned.
     * @param expand - A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.
     */
    retrieveAttributes(entityKey: string, successCallback: Function, errorCallback: Function, attributeType?: string, select?: string[], filter?: string, expand?: DynamicsWebApi.Expand[]): void;
    /**
     * Sends an asynchronous request to retrieve a specific attribute metadata for a specified entity definition.
     *
     * @param entityKey - The Entity MetadataId or Alternate Key (such as LogicalName).
     * @param attributeKey - The Attribute Metadata id.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param attributeType - Use this parameter to cast the Attribute to a specific type.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param expand - A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.
     */
    retrieveAttribute(entityKey: string, attributeKey: string, successCallback: Function, errorCallback: Function, attributeType?: string, select?: string[], expand?: DynamicsWebApi.Expand[]): void;
    /**
     * Sends an asynchronous request to create a relationship definition.
     *
     * @param relationshipDefinition - Relationship Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    createRelationship(relationshipDefinition: Object, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to update a relationship definition.
     *
     * @param relationshipDefinition - Relationship Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param relationshipType - Use this parameter to cast the Relationship to a specific type.
     * @param mergeLabels - Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.
     */
    updateRelationship(relationshipDefinition: Object, successCallback: Function, errorCallback: Function, relationshipType?: string, mergeLabels?: boolean): void;
    /**
     * Sends an asynchronous request to delete a relationship definition.
     *
     * @param metadataId - A String representing the GUID value.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    deleteRelationship(metadataId: string, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to retrieve relationship definitions.
     *
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param relationshipType - Use this parameter to cast a Relationship to a specific type: 1:M or M:M.
     * @param select - Use the $select system query option to limit the properties returned.
     * @param filter - Use the $filter system query option to set criteria for which relationships will be returned.
     */
    retrieveRelationships(successCallback: Function, errorCallback: Function, relationshipType?: string, select?: string[], filter?: string): void;
    /**
     * Sends an asynchronous request to retrieve a specific relationship definition.
     *
     * @param metadataId - String representing the Metadata Id GUID.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param relationshipType - Use this parameter to cast a Relationship to a specific type: 1:M or M:M.
     * @param select - Use the $select system query option to limit the properties returned.
     */
    retrieveRelationship(metadataId: string, successCallback: Function, errorCallback: Function, relationshipType?: string, select?: string[]): void;
    /**
     * Sends an asynchronous request to create a Global Option Set definition
     *
     * @param globalOptionSetDefinition - Global Option Set Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    createGlobalOptionSet(globalOptionSetDefinition: Object, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to update a Global Option Set.
     *
     * @param globalOptionSetDefinition - Global Option Set Definition.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param mergeLabels - Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.
     */
    updateGlobalOptionSet(globalOptionSetDefinition: Object, successCallback: Function, errorCallback: Function, mergeLabels?: boolean): void;
    /**
     * Sends an asynchronous request to delete a Global Option Set.
     *
     * @param globalOptionSetKey - A String representing the GUID value or Alternate Key (such as Name).
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    deleteGlobalOptionSet(globalOptionSetKey: string, successCallback: Function, errorCallback: Function): void;
    /**
     * Sends an asynchronous request to retrieve Global Option Set definitions.
     *
     * @param globalOptionSetKey - The Global Option Set MetadataID or Alternate Key (such as Name).
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param castType - Use this parameter to cast a Global Option Set to a specific type.
     * @param select - Use the $select system query option to limit the properties returned
     */
    retrieveGlobalOptionSet(globalOptionSetKey: string, successCallback: Function, errorCallback: Function, castType?: string, select?: string[]): void;
    /**
     * Sends an asynchronous request to retrieve Global Option Set definitions.
     *
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     * @param castType - Use this parameter to cast a Global Option Set to a specific type.
     * @param select - Use the $select system query option to limit the properties returned
     */
    retrieveGlobalOptionSets(successCallback: Function, errorCallback: Function, castType?: string, select?: string[]): void;
    /**
     * Starts a batch request.
     *
     */
    startBatch(): void;
    /**
     * Executes a batch request. Please call DynamicsWebApi.startBatch() first to start a batch request.
     * @param successCallback - The function that will be passed through and be called by a successful response.
     * @param errorCallback - The function that will be passed through and be called by a failed response.
     */
    executeBatch(successCallback: Function, errorCallback: Function) : void;
    /**
     * Creates a new instance of DynamicsWebApi
     *
     * @param config - configuration object.
     */
    initializeInstance(config?: DynamicsWebApi.Config): DynamicsWebApi;
    utility: DynamicsWebApi.Utility;
}

declare namespace DynamicsWebApi {
    interface Expand {
        /**An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned. */
        select?: string[];
        /**Use the $filter system query option to set criteria for which entities will be returned. */
        filter?: string;
        /**Limit the number of results returned by using the $top system query option.Do not use $top with $count! */
        top?: number
        /**An Array(of Strings) representing the order in which items are returned using the $orderby system query option.Use the asc or desc suffix to specify ascending or descending order respectively.The default is ascending if the suffix isn't applied. */
        orderBy?: string[]
        /**A name of a single-valued navigation property which needs to be expanded. */
        property?: string
    }

    interface Request {
        /**XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously). */
        async?: boolean;
        /**The name of the Entity Collection or Entity Logical name. */
        collection?: string;
        /**Impersonates the user.A String representing the GUID value for the Dynamics 365 system user id. */
        impersonate?: string;
        /** If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'. */
        noCache?: boolean;
        /** Authorization Token. If set, onTokenRefresh will not be called. */
        token?: string;
    }

    interface CRUDRequest extends Request {
        /** DEPRECATED Use "key" instead. A String representing the Primary Key(GUID) of the record. */
        id?: string;
        /**A String representing collection record's Primary Key (GUID) or Alternate Key(s). */
        key?: string;
    }

    interface CreateRequest extends CRUDRequest {
        /**v.1.3.4+ Web API v9+ only! Boolean that enables duplicate detection. */
        duplicateDetection?: boolean;
        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single - valued navigation properties). */
        entity?: any;
        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
        expand?: Expand[];
        /**Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types. */
        includeAnnotations?: string;
        /**A String representing the name of a single - valued navigation property.Useful when needed to retrieve information about a related record in a single request. */
        navigationProperty?: string;
        /**v.1.4.3 + A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata). */
        navigationPropertyKey?: string;
        /**Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request. */
        returnRepresentation?: boolean;
        /**BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set. */
        contentId?: string;
    }

    interface UpdateRequestBase extends CRUDRequest {
        /**v.1.3.4+ Web API v9+ only! Boolean that enables duplicate detection. */
        duplicateDetection?: boolean;
        /**A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single - valued navigation properties). */
        entity?: any;
        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
        expand?: Expand[];
        /**Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.*/
        ifmatch?: string;
        /**Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types. */
        includeAnnotations?: string;
        /**Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request. */
        returnRepresentation?: boolean;
        /**An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned. */
        select?: string[];
        /**BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set. */
        contentId?: string;
    }

    interface UpdateRequest extends UpdateRequestBase {
        /**If set to 'true', DynamicsWebApi adds a request header 'MSCRM.MergeLabels: true'. Default value is 'false' */
        mergeLabels?: boolean;
    }

    interface UpsertRequest extends UpdateRequestBase {
        /**Sets If-None-Match header value that enables to use conditional retrieval in applicable requests. */
        ifnonematch?: string;
        /**v.1.4.3 + Casts the AttributeMetadata to a specific type. (Used in requests to Attribute Metadata). */
        metadataAttributeType?: string;
        /**A String representing the name of a single - valued navigation property.Useful when needed to retrieve information about a related record in a single request. */
        navigationProperty?: string;
        /**v.1.4.3 + A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata). */
        navigationPropertyKey?: string;
    }

    interface DeleteRequest extends CRUDRequest {
        /**Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.*/
        ifmatch?: string;
        /**BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set. */
        contentId?: string;
    }

    interface RetrieveRequest extends CRUDRequest {
        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
        expand?: Expand[];
        /**Use the $filter system query option to set criteria for which entities will be returned. */
        filter?: string;
        /**Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.*/
        ifmatch?: string;
        /**Sets If-None-Match header value that enables to use conditional retrieval in applicable requests. */
        ifnonematch?: string;
        /**Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types. */
        includeAnnotations?: string;
        /**v.1.4.3 + Casts the AttributeMetadata to a specific type. (Used in requests to Attribute Metadata). */
        metadataAttributeType?: string;
        /**A String representing the name of a single - valued navigation property.Useful when needed to retrieve information about a related record in a single request. */
        navigationProperty?: string;
        /**v.1.4.3 + A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata). */
        navigationPropertyKey?: string;
        /**A String representing the GUID value of the saved query. */
        savedQuery?: string;
        /**An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned. */
        select?: string[];
        /**A String representing the GUID value of the user query. */
        userQuery?: string;
    }

    interface RetrieveMultipleRequest extends Request {
        /**An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned. */
        expand?: Expand[];
        /**Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000(per page).Do not use $top with $count! */
        count?: boolean;
        /**Use the $filter system query option to set criteria for which entities will be returned. */
        filter?: string;
        /**Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types. */
        includeAnnotations?: string;
        /**Sets the odata.maxpagesize preference value to request the number of entities returned in the response. */
        maxPageSize?: number;
        /**An Array(of string) representing the order in which items are returned using the $orderby system query option.Use the asc or desc suffix to specify ascending or descending order respectively.The default is ascending if the suffix isn't applied. */
        orderBy?: string[];
        /**An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned. */
        select?: string[];
        /**Limit the number of results returned by using the $top system query option.Do not use $top with $count! */
        top?: number;
    }

    interface Config {
        /**A String representing the GUID value for the Dynamics 365 system user id.Impersonates the user. */
        webApiUrl?: string;
        /**The version of Web API to use, for example: "8.1" */
        webApiVersion?: string;
        /**A String representing a URL to Web API(webApiVersion not required if webApiUrl specified)[not used inside of CRM] */
        impersonate?: string;
        /**A function that is called when a security token needs to be refreshed. */
        onTokenRefresh?: (callback: OnTokenAcquiredCallback) => void;
        /**Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types.*/
        includeAnnotations?: string;
        /**Sets the odata.maxpagesize preference value to request the number of entities returned in the response. */
        maxPageSize?: string;
        /**Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request.*/
        returnRepresentation?: boolean;
        /**Indicates whether to use Entity Logical Names instead of Collection Logical Names.*/
        useEntityNames?: boolean;
        /**Sets a number of milliseconds before a request times out */
        timeout?: number;
    }

    /** Callback with an acquired token called by DynamicsWebApi; "token" argument can be a string or an object with a property {accessToken: <token>}  */
    interface OnTokenAcquiredCallback {
        (token: any): void;
    }

    interface Utility {
        /**
         * Searches for a collection name by provided entity name in a cached entity metadata.
         * The returned collection name can be null.
         * @param entityName - entity name
         */
        getCollectionName(entityName: string): string;
    }

    interface RequestError {
        /**This code is not related to the http status code and is frequently empty */
        code?: string;
        /**A message describing the error */
        message: string;
        /**HTTP status code */
        status?: number;
        /**HTTP status text. Frequently empty */
        statusText?: string;
        /**Details about an error */
        innererror?: {
            /**A message describing the error, this is frequently the same as the outer message */
            message?: string;
            /**Microsoft.Crm.CrmHttpException */
            type?: string;
            /**Details from the server about where the error occurred */
            stacktrace?: string;
        }
    }
}