@sinoia/hubdoc-tools 1.0.4 → 1.2.1

package/dist/api/api/groups-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 { Group } from '../models';
+import type { GroupMutation } from '../models';
+/**
+ * GroupsApi - axios parameter creator
+ */
+export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Récupère une liste de groupes selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[name_cont]=admin` pour chercher les groupes contenant \"admin\"
+     * @summary Lister les groupes
+     * @param {string} [sort] Champ de tri (name, description, created_at, updated_at, etc.)
+     * @param {ApiV1GroupsGetDirectionEnum} [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[name_cont]=admin` : nom contenant \"admin\" - `q[description_present]=true` : avec description - `q[external_id_eq]=ext-group` : identifiant externe exact
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsGet: (sort?: string, direction?: ApiV1GroupsGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Supprimer un groupe existant
+     * @summary Supprimer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdDelete: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Récupérer un groupe spécifique par identifiant
+     * @summary Récupérer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mettre à jour un groupe existant
+     * @summary Mettre à jour un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1GroupsIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdPatch: (id: string, contentType: ApiV1GroupsIdPatchContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Créer un nouveau groupe
+     * @summary Créer un groupe
+     * @param {ApiV1GroupsPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsPost: (contentType: ApiV1GroupsPostContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GroupsApi - functional programming interface
+ */
+export declare const GroupsApiFp: (configuration?: Configuration) => {
+    /**
+     * Récupère une liste de groupes selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[name_cont]=admin` pour chercher les groupes contenant \"admin\"
+     * @summary Lister les groupes
+     * @param {string} [sort] Champ de tri (name, description, created_at, updated_at, etc.)
+     * @param {ApiV1GroupsGetDirectionEnum} [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[name_cont]&#x3D;admin&#x60; : nom contenant \&quot;admin\&quot; - &#x60;q[description_present]&#x3D;true&#x60; : avec description - &#x60;q[external_id_eq]&#x3D;ext-group&#x60; : identifiant externe exact
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsGet(sort?: string, direction?: ApiV1GroupsGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Group>>>;
+    /**
+     * Supprimer un groupe existant
+     * @summary Supprimer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Récupérer un groupe spécifique par identifiant
+     * @summary Récupérer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Group>>;
+    /**
+     * Mettre à jour un groupe existant
+     * @summary Mettre à jour un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1GroupsIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdPatch(id: string, contentType: ApiV1GroupsIdPatchContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Group>>;
+    /**
+     * Créer un nouveau groupe
+     * @summary Créer un groupe
+     * @param {ApiV1GroupsPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsPost(contentType: ApiV1GroupsPostContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Group>>;
+};
+/**
+ * GroupsApi - factory interface
+ */
+export declare const GroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Récupère une liste de groupes selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[name_cont]=admin` pour chercher les groupes contenant \"admin\"
+     * @summary Lister les groupes
+     * @param {string} [sort] Champ de tri (name, description, created_at, updated_at, etc.)
+     * @param {ApiV1GroupsGetDirectionEnum} [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[name_cont]&#x3D;admin&#x60; : nom contenant \&quot;admin\&quot; - &#x60;q[description_present]&#x3D;true&#x60; : avec description - &#x60;q[external_id_eq]&#x3D;ext-group&#x60; : identifiant externe exact
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsGet(sort?: string, direction?: ApiV1GroupsGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<Array<Group>>;
+    /**
+     * Supprimer un groupe existant
+     * @summary Supprimer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Récupérer un groupe spécifique par identifiant
+     * @summary Récupérer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Group>;
+    /**
+     * Mettre à jour un groupe existant
+     * @summary Mettre à jour un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1GroupsIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdPatch(id: string, contentType: ApiV1GroupsIdPatchContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): AxiosPromise<Group>;
+    /**
+     * Créer un nouveau groupe
+     * @summary Créer un groupe
+     * @param {ApiV1GroupsPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsPost(contentType: ApiV1GroupsPostContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): AxiosPromise<Group>;
+};
+/**
+ * GroupsApi - object-oriented interface
+ */
+export declare class GroupsApi extends BaseAPI {
+    /**
+     * Récupère une liste de groupes selon les paramètres de filtrage fournis.  **Filtrage avancé avec Ransack :** - Utilisez le paramètre `q` pour des recherches avancées - Exemple : `q[name_cont]=admin` pour chercher les groupes contenant \"admin\"
+     * @summary Lister les groupes
+     * @param {string} [sort] Champ de tri (name, description, created_at, updated_at, etc.)
+     * @param {ApiV1GroupsGetDirectionEnum} [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[name_cont]&#x3D;admin&#x60; : nom contenant \&quot;admin\&quot; - &#x60;q[description_present]&#x3D;true&#x60; : avec description - &#x60;q[external_id_eq]&#x3D;ext-group&#x60; : identifiant externe exact
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsGet(sort?: string, direction?: ApiV1GroupsGetDirectionEnum, perPage?: number, page?: number, q?: {
+        [key: string]: any;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Group[], any, {}>>;
+    /**
+     * Supprimer un groupe existant
+     * @summary Supprimer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Récupérer un groupe spécifique par identifiant
+     * @summary Récupérer un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Group, any, {}>>;
+    /**
+     * Mettre à jour un groupe existant
+     * @summary Mettre à jour un groupe
+     * @param {string} id Identifiant de la ressource
+     * @param {ApiV1GroupsIdPatchContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsIdPatch(id: string, contentType: ApiV1GroupsIdPatchContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Group, any, {}>>;
+    /**
+     * Créer un nouveau groupe
+     * @summary Créer un groupe
+     * @param {ApiV1GroupsPostContentTypeEnum} contentType Type de contenu de la requête
+     * @param {GroupMutation} groupMutation
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV1GroupsPost(contentType: ApiV1GroupsPostContentTypeEnum, groupMutation: GroupMutation, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Group, any, {}>>;
+}
+export declare const ApiV1GroupsGetDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ApiV1GroupsGetDirectionEnum = typeof ApiV1GroupsGetDirectionEnum[keyof typeof ApiV1GroupsGetDirectionEnum];
+export declare const ApiV1GroupsIdPatchContentTypeEnum: {
+    readonly ApplicationJson: "application/json";
+};
+export type ApiV1GroupsIdPatchContentTypeEnum = typeof ApiV1GroupsIdPatchContentTypeEnum[keyof typeof ApiV1GroupsIdPatchContentTypeEnum];
+export declare const ApiV1GroupsPostContentTypeEnum: {
+    readonly ApplicationJson: "application/json";
+};
+export type ApiV1GroupsPostContentTypeEnum = typeof ApiV1GroupsPostContentTypeEnum[keyof typeof ApiV1GroupsPostContentTypeEnum];
+//# sourceMappingURL=groups-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"groups-api.d.ts","sourceRoot":"","sources":["../../../src/api/api/groups-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,KAAK,EAAE,MAAM,WAAW,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C;;GAEG;AACH,eAAO,MAAM,0BAA0B,GAAa,gBAAgB,aAAa;IAEzE;;;;;;;;;;OAUG;4BAC2B,MAAM,cAAc,2BAA2B,YAAY,MAAM,SAAS,MAAM,MAAM;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAsDvM;;;;;;OAMG;8BAC6B,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAmClG;;;;;;OAMG;2BAC0B,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAmC/F;;;;;;;;OAQG;6BAC4B,MAAM,eAAe,iCAAiC,iBAAiB,aAAa,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA6C/K;;;;;;;OAOG;mCACkC,8BAA8B,iBAAiB,aAAa,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CA2CpK,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAY,gBAAgB,aAAa;IAGzD;;;;;;;;;;OAUG;0BACyB,MAAM,cAAc,2BAA2B,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,KAAK,CAAC,CAAC,CAAC;IAM9P;;;;;;OAMG;4BAC2B,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAMjJ;;;;;;OAMG;yBACwB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC;IAM/I;;;;;;;;OAQG;2BAC0B,MAAM,eAAe,iCAAiC,iBAAiB,aAAa,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC;IAM/N;;;;;;;OAOG;iCACgC,8BAA8B,iBAAiB,aAAa,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC;CAOpN,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGzG;;;;;;;;;;OAUG;0BACmB,MAAM,cAAc,2BAA2B,YAAY,MAAM,SAAS,MAAM,MAAM;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,YAAY,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAGjM;;;;;;OAMG;4BACqB,MAAM,YAAY,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;IAGpF;;;;;;OAMG;yBACkB,MAAM,YAAY,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC;IAGlF;;;;;;;;OAQG;2BACoB,MAAM,eAAe,iCAAiC,iBAAiB,aAAa,YAAY,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC;IAGlK;;;;;;;OAOG;iCAC0B,8BAA8B,iBAAiB,aAAa,YAAY,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC;CAIvJ,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,2BAA2B,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;IAI3K;;;;;;OAMG;IACI,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAItE;;;;;;OAMG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAInE;;;;;;;;OAQG;IACI,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,iCAAiC,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAInJ;;;;;;;OAOG;IACI,eAAe,CAAC,WAAW,EAAE,8BAA8B,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGpI;AAED,eAAO,MAAM,2BAA2B;;;CAG9B,CAAC;AACX,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC;AACvH,eAAO,MAAM,iCAAiC;;CAEpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,OAAO,iCAAiC,CAAC,MAAM,OAAO,iCAAiC,CAAC,CAAC;AACzI,eAAO,MAAM,8BAA8B;;CAEjC,CAAC;AACX,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAC,MAAM,OAAO,8BAA8B,CAAC,CAAC"}