@dataggo/node-akeneo-api 1.0.0 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/cjs/index.d.ts +159 -1
  2. package/dist/mjs/index.d.ts +159 -1
  3. package/package.json +1 -1
package/dist/cjs/index.d.ts CHANGED
@@ -4,6 +4,164 @@
4
4
  */
5
5
  import { AxiosInstance } from 'axios';
6
6
  import { AppParams, ClientParams } from './types';
7
+ declare const getHttpClientWithEndpoint: (http: AxiosInstance) => {
8
+ raw: {
9
+ http: AxiosInstance;
10
+ };
11
+ category: {
12
+ getOne: (params: {
13
+ code: string;
14
+ query?: {
15
+ with_attribute_options?: boolean | undefined;
16
+ with_quality_scores?: boolean | undefined;
17
+ } | undefined;
18
+ }) => Promise<import("./types").Category<Record<string, any>>>;
19
+ get: (params: {
20
+ query?: import("./types").CategoryQueryParameters | undefined;
21
+ }) => Promise<import("./types").ListResponse<import("./types").Category<Record<string, any>>>>;
22
+ getAll: (params: {
23
+ query?: import("./types").CategoryQueryParameters | undefined;
24
+ }) => Promise<import("./types").ListResponse<import("./types").Category<Record<string, any>>>>;
25
+ };
26
+ productModel: {
27
+ getOne: (params: {
28
+ code: string;
29
+ }) => Promise<import("./types").ProductModel>;
30
+ get: (params: {
31
+ query?: import("./types").ProductModelQueryParameters | undefined;
32
+ }) => Promise<import("./types").ListResponse<import("./types").ProductModel>>;
33
+ getAll: (params: {
34
+ query?: import("./types").ProductModelQueryParameters | undefined;
35
+ }) => Promise<import("./types").ListResponse<import("./types").ProductModel>>;
36
+ };
37
+ product: {
38
+ getOne: (params: {
39
+ code: string;
40
+ query?: {
41
+ with_attribute_options?: boolean | undefined;
42
+ with_quality_scores?: boolean | undefined;
43
+ } | undefined;
44
+ }) => Promise<import("./types").Product>;
45
+ get: (params: {
46
+ query?: import("./types").ProductQueryParameters | undefined;
47
+ }) => Promise<import("./types").ListResponse<import("./types").Product>>;
48
+ getAll: (params: {
49
+ query?: import("./types").ProductQueryParameters | undefined;
50
+ }) => Promise<import("./types").ListResponse<import("./types").Product>>;
51
+ };
52
+ assetFamily: {
53
+ getOne: (params: {
54
+ code: string;
55
+ query?: {
56
+ with_attribute_options?: boolean | undefined;
57
+ with_quality_scores?: boolean | undefined;
58
+ } | undefined;
59
+ }) => Promise<import("./types").AssetFamily>;
60
+ get: (params: {
61
+ query?: import("./types").AssetFamilyQueryParameters | undefined;
62
+ }) => Promise<import("./types").ListResponse<import("./types").AssetFamily>>;
63
+ getAll: (params: {
64
+ query?: import("./types").AssetFamilyQueryParameters | undefined;
65
+ }) => Promise<import("./types").ListResponse<import("./types").AssetFamily>>;
66
+ getAssets: (params: {
67
+ assetFamilyCode: string;
68
+ query?: import("./types").AssetQueryParameters | undefined;
69
+ }) => Promise<import("./types").ListResponse<import("./types").Asset>>;
70
+ getAsset: (params: {
71
+ assetFamilyCode: string;
72
+ code: string;
73
+ }) => Promise<import("./types").Asset>;
74
+ getAssetsAll: (params: {
75
+ assetFamilyCode: string;
76
+ query?: import("./types").AssetQueryParameters | undefined;
77
+ }) => Promise<import("./types").ListResponse<import("./types").Asset>>;
78
+ };
79
+ assetMediaFile: {
80
+ /**
81
+ *
82
+ * @see https://api.akeneo.com/api-reference.html#get_asset_media_files__code
83
+ */
84
+ get: (code: string) => Promise<import("axios").AxiosResponse<any>>;
85
+ };
86
+ referenceEntitiesMediaFile: {
87
+ /**
88
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entity_media_files__code
89
+ */
90
+ get: (code: string) => Promise<any>;
91
+ };
92
+ attribute: {
93
+ getOne: (params: {
94
+ code: string;
95
+ }) => Promise<import("./types").Attribute>;
96
+ get: (params: {
97
+ query?: import("./types").AttributeQueryParameters | undefined;
98
+ }) => Promise<import("./types").ListResponse<import("./types").Attribute>>;
99
+ getAll: (params: {
100
+ query?: import("./types").AttributeQueryParameters | undefined;
101
+ }) => Promise<import("./types").ListResponse<import("./types").Attribute>>;
102
+ getOptions: (params: {
103
+ attributeCode: string;
104
+ query?: import("./types").AttributeOptionQueryParameters | undefined;
105
+ }) => Promise<import("./types").ListResponse<import("./types").AttributeOption>>;
106
+ add: ({ code, attribute }: {
107
+ code: string;
108
+ attribute: any;
109
+ }) => Promise<import("axios").AxiosResponse<any>>;
110
+ addOption: ({ attributeCode, code, option, }: {
111
+ attributeCode: string;
112
+ code: string;
113
+ option: any;
114
+ }) => Promise<import("axios").AxiosResponse<any>>;
115
+ };
116
+ referenceEntity: {
117
+ get: (params: {
118
+ query?: import("./types").ReferenceEntityQueryParameters | undefined;
119
+ }) => Promise<import("./types").ListResponse<import("./types").Entity>>;
120
+ getRecords: (params: {
121
+ referenceEntityCode: string;
122
+ query?: import("./types").ReferenceEntityRecordQueryParameters | undefined;
123
+ }) => Promise<import("./types").ListResponse<import("./types").EntityRecord>>;
124
+ /**
125
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity__code_
126
+ */ add: ({ code, body }: {
127
+ code: string;
128
+ body: any;
129
+ }) => Promise<import("axios").AxiosResponse<any>>;
130
+ /**
131
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__code_
132
+ */
133
+ addAttribute: ({ referenceEntityCode, code, attribute, }: {
134
+ referenceEntityCode: string;
135
+ code: string;
136
+ attribute: any;
137
+ }) => Promise<void>;
138
+ /**
139
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__attribute_code__options__code_
140
+ */
141
+ addAttributeOption: ({ referenceEntityCode, attributeCode, code, option, }: {
142
+ referenceEntityCode: string;
143
+ attributeCode: string;
144
+ code: string;
145
+ option: any;
146
+ }) => Promise<import("axios").AxiosResponse<any>>;
147
+ /**
148
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_records
149
+ */
150
+ addRecords: ({ referenceEntityCode, records, }: {
151
+ referenceEntityCode: string;
152
+ records: any[];
153
+ }) => Promise<import("axios").AxiosResponse<any>>;
154
+ };
155
+ family: {
156
+ get: (params: {
157
+ query?: import("./types").FamilyQueryParameters | undefined;
158
+ }) => Promise<import("./types").ListResponse<import("./types").Family>>;
159
+ getVariants: (params: {
160
+ familyCode: string;
161
+ query?: import("./types").FamilyVariantQueryParameters | undefined;
162
+ }) => Promise<import("./types").ListResponse<import("./types").Variant>>;
163
+ };
164
+ };
7
165
  /**
8
166
  * Create a client instance
9
167
  * @param params - Client initialization parameters
@@ -345,5 +503,5 @@ export declare const createAppClient: (params: AppParams) => {
345
503
  }) => Promise<import("./types").ListResponse<import("./types").Variant>>;
346
504
  };
347
505
  };
348
- export declare type AkeneoClientAPI = ReturnType<typeof createClient>;
506
+ export declare type AkeneoClientAPI = ReturnType<typeof getHttpClientWithEndpoint>;
349
507
  export * from './types';
package/dist/mjs/index.d.ts CHANGED
@@ -4,6 +4,164 @@
4
4
  */
5
5
  import { AxiosInstance } from 'axios';
6
6
  import { AppParams, ClientParams } from './types';
7
+ declare const getHttpClientWithEndpoint: (http: AxiosInstance) => {
8
+ raw: {
9
+ http: AxiosInstance;
10
+ };
11
+ category: {
12
+ getOne: (params: {
13
+ code: string;
14
+ query?: {
15
+ with_attribute_options?: boolean | undefined;
16
+ with_quality_scores?: boolean | undefined;
17
+ } | undefined;
18
+ }) => Promise<import("./types").Category<Record<string, any>>>;
19
+ get: (params: {
20
+ query?: import("./types").CategoryQueryParameters | undefined;
21
+ }) => Promise<import("./types").ListResponse<import("./types").Category<Record<string, any>>>>;
22
+ getAll: (params: {
23
+ query?: import("./types").CategoryQueryParameters | undefined;
24
+ }) => Promise<import("./types").ListResponse<import("./types").Category<Record<string, any>>>>;
25
+ };
26
+ productModel: {
27
+ getOne: (params: {
28
+ code: string;
29
+ }) => Promise<import("./types").ProductModel>;
30
+ get: (params: {
31
+ query?: import("./types").ProductModelQueryParameters | undefined;
32
+ }) => Promise<import("./types").ListResponse<import("./types").ProductModel>>;
33
+ getAll: (params: {
34
+ query?: import("./types").ProductModelQueryParameters | undefined;
35
+ }) => Promise<import("./types").ListResponse<import("./types").ProductModel>>;
36
+ };
37
+ product: {
38
+ getOne: (params: {
39
+ code: string;
40
+ query?: {
41
+ with_attribute_options?: boolean | undefined;
42
+ with_quality_scores?: boolean | undefined;
43
+ } | undefined;
44
+ }) => Promise<import("./types").Product>;
45
+ get: (params: {
46
+ query?: import("./types").ProductQueryParameters | undefined;
47
+ }) => Promise<import("./types").ListResponse<import("./types").Product>>;
48
+ getAll: (params: {
49
+ query?: import("./types").ProductQueryParameters | undefined;
50
+ }) => Promise<import("./types").ListResponse<import("./types").Product>>;
51
+ };
52
+ assetFamily: {
53
+ getOne: (params: {
54
+ code: string;
55
+ query?: {
56
+ with_attribute_options?: boolean | undefined;
57
+ with_quality_scores?: boolean | undefined;
58
+ } | undefined;
59
+ }) => Promise<import("./types").AssetFamily>;
60
+ get: (params: {
61
+ query?: import("./types").AssetFamilyQueryParameters | undefined;
62
+ }) => Promise<import("./types").ListResponse<import("./types").AssetFamily>>;
63
+ getAll: (params: {
64
+ query?: import("./types").AssetFamilyQueryParameters | undefined;
65
+ }) => Promise<import("./types").ListResponse<import("./types").AssetFamily>>;
66
+ getAssets: (params: {
67
+ assetFamilyCode: string;
68
+ query?: import("./types").AssetQueryParameters | undefined;
69
+ }) => Promise<import("./types").ListResponse<import("./types").Asset>>;
70
+ getAsset: (params: {
71
+ assetFamilyCode: string;
72
+ code: string;
73
+ }) => Promise<import("./types").Asset>;
74
+ getAssetsAll: (params: {
75
+ assetFamilyCode: string;
76
+ query?: import("./types").AssetQueryParameters | undefined;
77
+ }) => Promise<import("./types").ListResponse<import("./types").Asset>>;
78
+ };
79
+ assetMediaFile: {
80
+ /**
81
+ *
82
+ * @see https://api.akeneo.com/api-reference.html#get_asset_media_files__code
83
+ */
84
+ get: (code: string) => Promise<import("axios").AxiosResponse<any>>;
85
+ };
86
+ referenceEntitiesMediaFile: {
87
+ /**
88
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entity_media_files__code
89
+ */
90
+ get: (code: string) => Promise<any>;
91
+ };
92
+ attribute: {
93
+ getOne: (params: {
94
+ code: string;
95
+ }) => Promise<import("./types").Attribute>;
96
+ get: (params: {
97
+ query?: import("./types").AttributeQueryParameters | undefined;
98
+ }) => Promise<import("./types").ListResponse<import("./types").Attribute>>;
99
+ getAll: (params: {
100
+ query?: import("./types").AttributeQueryParameters | undefined;
101
+ }) => Promise<import("./types").ListResponse<import("./types").Attribute>>;
102
+ getOptions: (params: {
103
+ attributeCode: string;
104
+ query?: import("./types").AttributeOptionQueryParameters | undefined;
105
+ }) => Promise<import("./types").ListResponse<import("./types").AttributeOption>>;
106
+ add: ({ code, attribute }: {
107
+ code: string;
108
+ attribute: any;
109
+ }) => Promise<import("axios").AxiosResponse<any>>;
110
+ addOption: ({ attributeCode, code, option, }: {
111
+ attributeCode: string;
112
+ code: string;
113
+ option: any;
114
+ }) => Promise<import("axios").AxiosResponse<any>>;
115
+ };
116
+ referenceEntity: {
117
+ get: (params: {
118
+ query?: import("./types").ReferenceEntityQueryParameters | undefined;
119
+ }) => Promise<import("./types").ListResponse<import("./types").Entity>>;
120
+ getRecords: (params: {
121
+ referenceEntityCode: string;
122
+ query?: import("./types").ReferenceEntityRecordQueryParameters | undefined;
123
+ }) => Promise<import("./types").ListResponse<import("./types").EntityRecord>>;
124
+ /**
125
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity__code_
126
+ */ add: ({ code, body }: {
127
+ code: string;
128
+ body: any;
129
+ }) => Promise<import("axios").AxiosResponse<any>>;
130
+ /**
131
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__code_
132
+ */
133
+ addAttribute: ({ referenceEntityCode, code, attribute, }: {
134
+ referenceEntityCode: string;
135
+ code: string;
136
+ attribute: any;
137
+ }) => Promise<void>;
138
+ /**
139
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__attribute_code__options__code_
140
+ */
141
+ addAttributeOption: ({ referenceEntityCode, attributeCode, code, option, }: {
142
+ referenceEntityCode: string;
143
+ attributeCode: string;
144
+ code: string;
145
+ option: any;
146
+ }) => Promise<import("axios").AxiosResponse<any>>;
147
+ /**
148
+ * @see https://api.akeneo.com/api-reference.html#patch_reference_entity_records
149
+ */
150
+ addRecords: ({ referenceEntityCode, records, }: {
151
+ referenceEntityCode: string;
152
+ records: any[];
153
+ }) => Promise<import("axios").AxiosResponse<any>>;
154
+ };
155
+ family: {
156
+ get: (params: {
157
+ query?: import("./types").FamilyQueryParameters | undefined;
158
+ }) => Promise<import("./types").ListResponse<import("./types").Family>>;
159
+ getVariants: (params: {
160
+ familyCode: string;
161
+ query?: import("./types").FamilyVariantQueryParameters | undefined;
162
+ }) => Promise<import("./types").ListResponse<import("./types").Variant>>;
163
+ };
164
+ };
7
165
  /**
8
166
  * Create a client instance
9
167
  * @param params - Client initialization parameters
@@ -345,5 +503,5 @@ export declare const createAppClient: (params: AppParams) => {
345
503
  }) => Promise<import("./types").ListResponse<import("./types").Variant>>;
346
504
  };
347
505
  };
348
- export declare type AkeneoClientAPI = ReturnType<typeof createClient>;
506
+ export declare type AkeneoClientAPI = ReturnType<typeof getHttpClientWithEndpoint>;
349
507
  export * from './types';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dataggo/node-akeneo-api",
3
- "version": "1.0.0",
3
+ "version": "1.0.4",
4
4
  "description": "A Node Rest Client for the Akeneo PIM",
5
5
  "author": "Constant B <contact@dataggo>",
6
6
  "license": "MIT",