@sinoia/hubdoc-tools 1.2.1 → 1.3.1

package/dist/api/api/users-api.d.ts

@@ -0,0 +1,246 @@
+/**
+ * Hubdoc API
+ * API documentation for Hubdoc
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sinoia.fr
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { User } from '../models';
+import type { UserMutation } from '../models';
+/**
+ * UsersApi - axios parameter creator
+ */
+export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Récupère une liste d\'utilisateurs selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[role_eq]=admin` pour chercher les utilisateurs administrateurs
+     * @summary Lister les utilisateurs
+     * @param {string} [sort] Champ de tri (email_address, first_name, last_name, role, created_at, updated_at, etc.)
+     * @param {ApiV1UsersGetDirectionEnum} [direction] Direction du tri
+     * @param {number} [perPage] Nombre d\'éléments par page
+     * @param {number} [page] Numéro de page
+     * @param {{ [key: string]: any; }} [q] Filtres Ransack pour recherche avancée. Exemples : - `q[email_address_cont]=john` : email contenant \"john\" - `q[role_eq]=admin` : rôle exact - `q[first_name_or_last_name_cont]=doe` : prénom ou nom contenant \"doe\"
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersGet: (sort?: string, direction?: ApiV1UsersGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Supprimer un utilisateur existant
+     * @summary Supprimer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdDelete: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Récupérer un utilisateur spécifique par identifiant
+     * @summary Récupérer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mettre à jour un utilisateur existant
+     * @summary Mettre à jour un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1UsersIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdPatch: (id: string, contentType: ApiV1UsersIdPatchContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Créer un nouvel utilisateur
+     * @summary Créer un utilisateur
+     * @param {ApiV1UsersPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersPost: (contentType: ApiV1UsersPostContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UsersApi - functional programming interface
+ */
+export declare const UsersApiFp: (configuration?: Configuration) => {
+    /**
+     * Récupère une liste d\'utilisateurs selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[role_eq]=admin` pour chercher les utilisateurs administrateurs
+     * @summary Lister les utilisateurs
+     * @param {string} [sort] Champ de tri (email_address, first_name, last_name, role, created_at, updated_at, etc.)
+     * @param {ApiV1UsersGetDirectionEnum} [direction] Direction du tri
+     * @param {number} [perPage] Nombre d\&#39;éléments par page
+     * @param {number} [page] Numéro de page
+     * @param {{ [key: string]: any; }} [q] Filtres Ransack pour recherche avancée. Exemples : - &#x60;q[email_address_cont]&#x3D;john&#x60; : email contenant \&quot;john\&quot; - &#x60;q[role_eq]&#x3D;admin&#x60; : rôle exact - &#x60;q[first_name_or_last_name_cont]&#x3D;doe&#x60; : prénom ou nom contenant \&quot;doe\&quot;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersGet(sort?: string, direction?: ApiV1UsersGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<User>>>;
+    /**
+     * Supprimer un utilisateur existant
+     * @summary Supprimer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Récupérer un utilisateur spécifique par identifiant
+     * @summary Récupérer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+    /**
+     * Mettre à jour un utilisateur existant
+     * @summary Mettre à jour un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1UsersIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdPatch(id: string, contentType: ApiV1UsersIdPatchContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+    /**
+     * Créer un nouvel utilisateur
+     * @summary Créer un utilisateur
+     * @param {ApiV1UsersPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersPost(contentType: ApiV1UsersPostContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
+};
+/**
+ * UsersApi - factory interface
+ */
+export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Récupère une liste d\'utilisateurs selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[role_eq]=admin` pour chercher les utilisateurs administrateurs
+     * @summary Lister les utilisateurs
+     * @param {string} [sort] Champ de tri (email_address, first_name, last_name, role, created_at, updated_at, etc.)
+     * @param {ApiV1UsersGetDirectionEnum} [direction] Direction du tri
+     * @param {number} [perPage] Nombre d\&#39;éléments par page
+     * @param {number} [page] Numéro de page
+     * @param {{ [key: string]: any; }} [q] Filtres Ransack pour recherche avancée. Exemples : - &#x60;q[email_address_cont]&#x3D;john&#x60; : email contenant \&quot;john\&quot; - &#x60;q[role_eq]&#x3D;admin&#x60; : rôle exact - &#x60;q[first_name_or_last_name_cont]&#x3D;doe&#x60; : prénom ou nom contenant \&quot;doe\&quot;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersGet(sort?: string, direction?: ApiV1UsersGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<Array<User>>;
+    /**
+     * Supprimer un utilisateur existant
+     * @summary Supprimer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Récupérer un utilisateur spécifique par identifiant
+     * @summary Récupérer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+    /**
+     * Mettre à jour un utilisateur existant
+     * @summary Mettre à jour un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1UsersIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdPatch(id: string, contentType: ApiV1UsersIdPatchContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+    /**
+     * Créer un nouvel utilisateur
+     * @summary Créer un utilisateur
+     * @param {ApiV1UsersPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersPost(contentType: ApiV1UsersPostContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): AxiosPromise<User>;
+};
+/**
+ * UsersApi - object-oriented interface
+ */
+export declare class UsersApi extends BaseAPI {
+    /**
+     * Récupère une liste d\'utilisateurs selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[role_eq]=admin` pour chercher les utilisateurs administrateurs
+     * @summary Lister les utilisateurs
+     * @param {string} [sort] Champ de tri (email_address, first_name, last_name, role, created_at, updated_at, etc.)
+     * @param {ApiV1UsersGetDirectionEnum} [direction] Direction du tri
+     * @param {number} [perPage] Nombre d\&#39;éléments par page
+     * @param {number} [page] Numéro de page
+     * @param {{ [key: string]: any; }} [q] Filtres Ransack pour recherche avancée. Exemples : - &#x60;q[email_address_cont]&#x3D;john&#x60; : email contenant \&quot;john\&quot; - &#x60;q[role_eq]&#x3D;admin&#x60; : rôle exact - &#x60;q[first_name_or_last_name_cont]&#x3D;doe&#x60; : prénom ou nom contenant \&quot;doe\&quot;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersGet(sort?: string, direction?: ApiV1UsersGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<User[], any, {}>>;
+    /**
+     * Supprimer un utilisateur existant
+     * @summary Supprimer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Récupérer un utilisateur spécifique par identifiant
+     * @summary Récupérer un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<User, any, {}>>;
+    /**
+     * Mettre à jour un utilisateur existant
+     * @summary Mettre à jour un utilisateur
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1UsersIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersIdPatch(id: string, contentType: ApiV1UsersIdPatchContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<User, any, {}>>;
+    /**
+     * Créer un nouvel utilisateur
+     * @summary Créer un utilisateur
+     * @param {ApiV1UsersPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {UserMutation} userMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1UsersPost(contentType: ApiV1UsersPostContentTypeEnum, userMutation: UserMutation, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<User, any, {}>>;
+}
+export declare const ApiV1UsersGetDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ApiV1UsersGetDirectionEnum = typeof ApiV1UsersGetDirectionEnum[keyof typeof ApiV1UsersGetDirectionEnum];
+export declare const ApiV1UsersIdPatchContentTypeEnum: {
+    readonly ApplicationJson: "application/json";
+};
+export type ApiV1UsersIdPatchContentTypeEnum = typeof ApiV1UsersIdPatchContentTypeEnum[keyof typeof ApiV1UsersIdPatchContentTypeEnum];
+export declare const ApiV1UsersPostContentTypeEnum: {
+    readonly ApplicationJson: "application/json";
+};
+export type ApiV1UsersPostContentTypeEnum = typeof ApiV1UsersPostContentTypeEnum[keyof typeof ApiV1UsersPostContentTypeEnum];
+//# sourceMappingURL=users-api.d.ts.map

package/dist/api/api/users-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users-api.d.ts","sourceRoot":"","sources":["../../../src/api/api/users-api.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAMhF,OAAO,EAAiC,KAAK,WAAW,EAAE,OAAO,EAAqC,MAAM,SAAS,CAAC;AAEtH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C;;GAEG;AACH,eAAO,MAAM,yBAAyB,GAAa,gBAAgB,aAAa;IAExE;;;;;;;;;;OAUG;2BAC0B,MAAM,cAAc,0BAA0B,YAAY,MAAM,SAAS,MAAM,MAAM;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAsDrM;;;;;;OAMG;6BAC4B,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAmCjG;;;;;;OAMG;0BACyB,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAmC9F;;;;;;;;OAQG;4BAC2B,MAAM,eAAe,gCAAgC,gBAAgB,YAAY,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA6C3K;;;;;;;OAOG;kCACiC,6BAA6B,gBAAgB,YAAY,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CA2ChK,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,GAAY,gBAAgB,aAAa;IAGxD;;;;;;;;;;OAUG;yBACwB,MAAM,cAAc,0BAA0B,YAAY,MAAM,SAAS,MAAM,MAAM;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAM3P;;;;;;OAMG;2BAC0B,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAMhJ;;;;;;OAMG;wBACuB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAM7I;;;;;;;;OAQG;0BACyB,MAAM,eAAe,gCAAgC,gBAAgB,YAAY,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAM1N;;;;;;;OAOG;gCAC+B,6BAA6B,gBAAgB,YAAY,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CAO/M,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGxG;;;;;;;;;;OAUG;yBACkB,MAAM,cAAc,0BAA0B,YAAY,MAAM,SAAS,MAAM,MAAM;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,YAAY,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAG9L;;;;;;OAMG;2BACoB,MAAM,YAAY,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;IAGnF;;;;;;OAMG;wBACiB,MAAM,YAAY,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;IAGhF;;;;;;;;OAQG;0BACmB,MAAM,eAAe,gCAAgC,gBAAgB,YAAY,YAAY,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;IAG7J;;;;;;;OAOG;gCACyB,6BAA6B,gBAAgB,YAAY,YAAY,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;CAIlJ,CAAC;AAEF;;GAEG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC;;;;;;;;;;OAUG;IACI,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIzK;;;;;;OAMG;IACI,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIrE;;;;;;OAMG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIlE;;;;;;;;OAQG;IACI,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI/I;;;;;;;OAOG;IACI,cAAc,CAAC,WAAW,EAAE,6BAA6B,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGhI;AAED,eAAO,MAAM,0BAA0B;;;CAG7B,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,OAAO,0BAA0B,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AACpH,eAAO,MAAM,gCAAgC;;CAEnC,CAAC;AACX,MAAM,MAAM,gCAAgC,GAAG,OAAO,gCAAgC,CAAC,MAAM,OAAO,gCAAgC,CAAC,CAAC;AACtI,eAAO,MAAM,6BAA6B;;CAEhC,CAAC;AACX,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC"}