@artisan-commerce/builders 0.6.0 → 0.7.0-canary.0

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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,15 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [0.7.0-canary.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/builders@0.6.0...@artisan-commerce/builders@0.7.0-canary.0) (2021-08-04)
7
+
8
+
9
+ ### Features
10
+
11
+ * **global:** add and export missing builders and types ([67ad6ac](https://bitbucket.org/tradesystem/artisan_sdk/commit/67ad6ac8e563aa53c2c62dac86b65f3435a0b16a))
12
+
13
+
14
+
6
15
  ## [0.6.0](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/builders@0.6.0-canary.11...@artisan-commerce/builders@0.6.0) (2021-07-30)
7
16
 
8
17
 
@@ -2,6 +2,7 @@ import { Account } from "@artisan-commerce/types";
2
2
  /**
3
3
  * Generates Account object with random data.
4
4
  *
5
+ * @since 0.5.14
5
6
  * @param {Partial<Account>} overrides Properties to override a {@link Account}
6
7
  * @returns {Account} A {@link Account} object
7
8
  */
@@ -9,6 +10,7 @@ export declare const buildAccount: (overrides?: Partial<Account>) => Account;
9
10
  /**
10
11
  * Generates a list of Account objects with random data.
11
12
  *
13
+ * @since 0.5.14
12
14
  * @param {number} quantity The number of objects to be generated
13
15
  * @returns {Account[]} An array of {@link Account}s objects
14
16
  */
@@ -3,6 +3,7 @@ import { Banner } from "@artisan-commerce/types";
3
3
  /**
4
4
  * Generates banner object with random data.
5
5
  *
6
+ * @since 0.5.14
6
7
  * @param {Partial<Banner>} overrides Properties to override a {@link Banner}
7
8
  * @returns {Banner} A {@link Banner} object
8
9
  */
@@ -10,6 +11,7 @@ export declare const buildBanner: (overrides?: Partial<Banner>) => Banner;
10
11
  /**
11
12
  * Generates a list of Banner objects with random data.
12
13
  *
14
+ * @since 0.5.14
13
15
  * @param {number} quantity The number of objects to be generated
14
16
  * @returns {Banner[]} An array of {@link Banner}s objects
15
17
  */
@@ -17,13 +19,16 @@ export declare const genBanners: (quantity?: number | undefined) => Banner[];
17
19
  /**
18
20
  * Generates BannerImage object with random data.
19
21
  *
20
- * @param {Partial<BannerImage>} overrides Properties to override a {@link BannerImage}
22
+ * @since 0.5.14
23
+ * @param {Partial<BannerImage>} overrides Properties to override
24
+ * a {@link BannerImage}
21
25
  * @returns {BannerImage} A {@link BannerImage} object
22
26
  */
23
27
  export declare const buildBannerImage: (overrides?: Partial<BannerImage>) => BannerImage;
24
28
  /**
25
29
  * Generates a list of banner image objects with random data.
26
30
  *
31
+ * @since 0.5.14
27
32
  * @param {number} quantity The number of objects to be generated
28
33
  * @returns {BannerImage[]} An array of banner images, see {@link BannerImage}
29
34
  */
@@ -2,13 +2,16 @@ import { BillingData } from "@artisan-commerce/types";
2
2
  /**
3
3
  * Generates BillingData object with random data.
4
4
  *
5
- * @param {Partial<BillingData>} overrides Properties to override a {@link BillingData}
5
+ * @since 0.5.14
6
+ * @param {Partial<BillingData>} overrides Properties to override
7
+ * a {@link BillingData}
6
8
  * @returns {BillingData} A {@link BillingData} object
7
9
  */
8
10
  export declare const buildBillingData: (overrides?: Partial<BillingData>) => BillingData;
9
11
  /**
10
12
  * Generates a list of Billing Data objects with random data.
11
13
  *
14
+ * @since 0.5.14
12
15
  * @param {number} quantity The number of objects to be generated
13
16
  * @returns {BillingData[]} An array of {@link BillingData}s objects
14
17
  */
@@ -2,13 +2,16 @@ import { Catalogue } from "@artisan-commerce/types";
2
2
  /**
3
3
  * Generates Catalogue object with random data.
4
4
  *
5
- * @param {Partial<Catalogue>} overrides Properties to override a {@link Catalogue}
5
+ * @since 0.5.14
6
+ * @param {Partial<Catalogue>} overrides Properties to override
7
+ * a {@link Catalogue}
6
8
  * @returns {Catalogue} A {@link Catalogue} object
7
9
  */
8
10
  export declare const buildCatalogue: (overrides?: Partial<Catalogue>) => Catalogue;
9
11
  /**
10
12
  * Generates a list of Catalogue objects with custom data.
11
13
  *
14
+ * @since 0.5.14
12
15
  * @param {number} quantity The number of objects to be generated
13
16
  * @returns {Catalogue[]} An array of {@link Catalogue}s objects
14
17
  */
@@ -2,13 +2,16 @@ import { Category, CategoryWithProducts } from "@artisan-commerce/types";
2
2
  /**
3
3
  * Generates Category object with random data.
4
4
  *
5
- * @param {Partial<Category>} overrides Properties to override a {@link Category}
5
+ * @since 0.5.14
6
+ * @param {Partial<Category>} overrides Properties to override
7
+ * a {@link Category}
6
8
  * @returns {Category} A {@link Category} object
7
9
  */
8
10
  export declare const buildCategory: (overrides?: Partial<Category>) => Category;
9
11
  /**
10
12
  * Generates a list of Category objects with random data.
11
13
  *
14
+ * @since 0.5.14
12
15
  * @param {number} quantity The number of objects to be generated
13
16
  * @returns {Category[]} An array of categories objects, see {@link Category}
14
17
  */
@@ -16,14 +19,18 @@ export declare const genCategories: (quantity?: number | undefined) => Category[
16
19
  /**
17
20
  * Generates CategoryWithProducts object with random data.
18
21
  *
19
- * @param {Partial<CategoryWithProducts>} overrides Properties to override a {@link CategoryWithProducts}
22
+ * @since 0.5.14
23
+ * @param {Partial<CategoryWithProducts>} overrides Properties to override
24
+ * a {@link CategoryWithProducts}
20
25
  * @returns {CategoryWithProducts} A {@link CategoryWithProducts} object
21
26
  */
22
27
  export declare const buildCategoryWithProducts: (overrides?: Partial<CategoryWithProducts>) => CategoryWithProducts;
23
28
  /**
24
29
  * Generates a list of CategoryWithProducts objects with random data.
25
30
  *
31
+ * @since 0.5.14
26
32
  * @param {number} quantity The number of objects to be generated
27
- * @returns {CategoryWithProducts[]} An array of products by categories, see {@link CategoryWithProducts}
33
+ * @returns {CategoryWithProducts[]} An array of products by categories,
34
+ * see {@link CategoryWithProducts}
28
35
  */
29
36
  export declare const genCategoryWithProducts: (quantity?: number | undefined) => CategoryWithProducts[];
@@ -1,33 +1,79 @@
1
- import { CountrySummary, URLImage } from "@artisan-commerce/types";
2
- import { DocumentType, CDNImage } from "@artisan-commerce/types";
1
+ import { DocumentType } from "@artisan-commerce/types";
2
+ import { CountrySummary, RandomImageConfig } from "@artisan-commerce/types";
3
3
  /**
4
4
  * Generates a random password.
5
5
  *
6
- * @param {any[]} args An array of arguments to be passed when generating the password
6
+ * @since 0.5.14
7
+ * @param {any[]} args An array of arguments to be passed when
8
+ * generating the password
7
9
  * @returns A random password
8
10
  */
9
11
  export declare const getPassword: (...args: any[]) => string;
10
- /** Generates a random username. */
12
+ /**
13
+ * Generates a random username.
14
+ *
15
+ * @since 0.5.14
16
+ */
11
17
  export declare const getUsername: (firstName?: string | undefined, lastName?: string | undefined) => string;
12
- /** Generates a random unique identifier. */
18
+ /**
19
+ * Generates a random unique identifier.
20
+ *
21
+ * @since 0.5.14
22
+ */
13
23
  export declare const genId: () => string;
14
- /** Generates a random id of type number. */
24
+ /**
25
+ * Generates a random id of type number.
26
+ *
27
+ * @since 0.5.14
28
+ */
15
29
  export declare const genNumericId: () => number;
16
- /** Generates a random word. */
30
+ /**
31
+ * Generates a random word.
32
+ *
33
+ * @since 0.5.14
34
+ */
17
35
  export declare const genWord: () => string;
18
- /** Generates a random address. */
36
+ /**
37
+ * Generates a random address.
38
+ *
39
+ * @since 0.5.14
40
+ */
19
41
  export declare const genAddress: (useFullAddress?: boolean | undefined) => string;
20
- /** Generates a random name. */
42
+ /**
43
+ * Generates a random name.
44
+ *
45
+ * @since 0.5.14
46
+ */
21
47
  export declare const genName: (firstName?: string | undefined, lastName?: string | undefined, gender?: number | undefined) => string;
22
- /** Generates a random email. */
48
+ /**
49
+ * Generates a random email.
50
+ *
51
+ * @since 0.5.14
52
+ */
23
53
  export declare const genEmail: (firstName?: string | undefined, lastName?: string | undefined, provider?: string | undefined) => string;
24
- /** Generates a random company name. */
54
+ /**
55
+ * Generates a random company name.
56
+ *
57
+ * @since 0.5.14
58
+ */
25
59
  export declare const genCompanyName: (format?: number | undefined) => string;
26
- /** Generates a random paragraph. */
60
+ /**
61
+ * Generates a random paragraph.
62
+ *
63
+ * @since 0.5.14
64
+ */
27
65
  export declare const genParagraph: (sentenceCount?: number | undefined) => string;
28
- /** Generates a random title containing 3 words. */
66
+ /**
67
+ * Generates a random title containing 3 words.
68
+ *
69
+ * @since 0.5.14
70
+ */
29
71
  export declare const genTitle: () => string;
30
- /** Generates a random number. */
72
+ /**
73
+ * Generates a random number.
74
+ *
75
+ * @since 0.5.14
76
+ */
31
77
  export declare const genNumber: {
32
78
  (max?: number | undefined): number;
33
79
  (options?: {
@@ -36,27 +82,57 @@ export declare const genNumber: {
36
82
  precision?: number | undefined;
37
83
  } | undefined): number;
38
84
  };
39
- /** Generates a random boolean value. */
85
+ /**
86
+ * Generates a random boolean value.
87
+ *
88
+ * @since 0.5.14
89
+ */
40
90
  export declare const getBoolean: () => boolean;
41
- /** Generates a random country name. */
91
+ /**
92
+ * Generates a random country name.
93
+ *
94
+ * @since 0.5.14
95
+ */
42
96
  export declare const genCountryName: () => string;
43
- /** Generates a random image. */
44
- export declare const genRandomImage: string;
97
+ /**
98
+ * Generates a random image based on custom configuration.
99
+ *
100
+ * @since 0.5.15
101
+ * @param {RandomImageConfig} randomImageConfig Configuration
102
+ * to generate a random image
103
+ * @returns {string} An url of the image generated
104
+ */
105
+ export declare const genRandomImage: (randomImageConfig?: RandomImageConfig | undefined) => string;
45
106
  /** Generates random words.
46
107
  *
108
+ * @since 0.5.14
47
109
  * @param {number} words The quantity of words to be generated
48
110
  */
49
111
  export declare const genWords: (words?: number | undefined) => string;
50
- /** Generates a random internet url. */
51
- export declare const genURL: string;
52
- /** Generates a random date in ISO format. */
53
- export declare const genDate: string;
54
- /** Generates a random base64 value. */
55
- export declare const genBase64: string;
112
+ /**
113
+ * Generates a random internet url.
114
+ *
115
+ * @since 0.5.14
116
+ */
117
+ export declare const genURL: () => string;
118
+ /**
119
+ * Generates a random date in ISO format.
120
+ *
121
+ * @since 0.5.14
122
+ */
123
+ export declare const genDate: () => string;
124
+ /**
125
+ * Generates a random base64 value.
126
+ *
127
+ * @since 0.5.14
128
+ */
129
+ export declare const genBase64: () => string;
56
130
  /**
57
131
  * Generates a random boolean value.
58
132
  *
59
- * @param {number} bias A number between 0 and 1 which will be used to generate a boolean
133
+ * @since 0.5.14
134
+ * @param {number} bias A number between 0 and 1 which will be used
135
+ * to generate a boolean
60
136
  * @throws Error if bias is not between 0 and 1
61
137
  * @returns {boolean} A boolean value
62
138
  */
@@ -64,15 +140,22 @@ export declare const genBiasBoolean: (bias: number) => boolean;
64
140
  /**
65
141
  * Generates a random document.
66
142
  *
67
- * @param {number} digits The number of digits with which the document will be generated
143
+ * @since 0.5.14
144
+ * @param {number} digits The number of digits with which the document
145
+ * will be generated
68
146
  * @returns {string} A random document
69
147
  */
70
148
  export declare const genDocument: (digits: number) => string;
71
- /** Generates a random document type. */
149
+ /**
150
+ * Generates a random document type.
151
+ *
152
+ * @since 0.5.14
153
+ */
72
154
  export declare const genDocumentType: () => DocumentType;
73
155
  /**
74
156
  * Generates a random mobile phone with the country code provided.
75
157
  *
158
+ * @since 0.5.14
76
159
  * @param {string} countryCode Country calling code
77
160
  * @returns {string} A string like a mobile phone
78
161
  */
@@ -80,6 +163,7 @@ export declare const genMobilPhone: (countryCode: string) => string;
80
163
  /**
81
164
  * Generates a Country Summary object with random data.
82
165
  *
166
+ * @since 0.5.14
83
167
  * @param {number} id Country specific id
84
168
  * @param {string} name Country specific name
85
169
  * @returns {CountrySummary} A {@link CountrySummary} object
@@ -88,14 +172,18 @@ export declare const genCountry: (id?: number | undefined, name?: string | undef
88
172
  /**
89
173
  * Fills a number of type string with characters.
90
174
  *
91
- * @param {string} num A string, the length of it will be used to fill the number
92
- * @param {number} max A number, the length of it will be used to fill the number
175
+ * @since 0.5.14
176
+ * @param {string} num A string, the length of it will
177
+ * be used to fill the number
178
+ * @param {number} max A number, the length of it will
179
+ * be used to fill the number
93
180
  * @returns {string} A string filled with the data passed
94
181
  */
95
182
  export declare const fillNumber: (num: string, max?: number | undefined) => string;
96
183
  /**
97
184
  * Chooses a random item inside the array provided.
98
185
  *
186
+ * @since 0.5.14
99
187
  * @param {T[]} arr An array of generic items
100
188
  * @returns {T} A random item of the array passed as param
101
189
  */
@@ -103,32 +191,14 @@ export declare const chooseRandom: <T>(arr: T[]) => T;
103
191
  /**
104
192
  * Chooses a random enum value of the enum provided.
105
193
  *
194
+ * @since 0.5.14
106
195
  * @param {T} anEnum An enum
107
196
  * @returns {T[keyof T]} A random item of the enum passed as param
108
197
  */
109
198
  export declare const chooseRandomEnum: <T>(anEnum: T) => T[keyof T];
110
- /** Generates a random currency symbol. */
111
- export declare const genSymbol: string;
112
- /** Generates a random image url. */
113
- export declare const buildURLImage: string;
114
199
  /**
115
- * Generates a list of URLImage.
200
+ * Generates a random currency symbol.
116
201
  *
117
- * @param {number} quantity The number of objects to be generated
118
- * @returns {URLImage} An array of {@link URLImage}
202
+ * @since 0.5.14
119
203
  */
120
- export declare const genURLImages: (quantity?: number | undefined) => URLImage[];
121
- /**
122
- * Generates CDNImage object with random data.
123
- *
124
- * @param {Partial<CDNImage>} overrides Properties to override a {@link CDNImage}
125
- * @returns {CDNImage} A {@link CDNImage} object
126
- */
127
- export declare const buildCDNImage: (overrides?: Partial<CDNImage>) => CDNImage;
128
- /**
129
- * Generates a list of CDNImage objects with random data.
130
- *
131
- * @param {number} quantity The number of objects to be generated
132
- * @returns {CDNImage[]} An array of CDNImage objects, see {@link CDNImage}
133
- */
134
- export declare const genCDNImages: (quantity?: number | undefined) => CDNImage[];
204
+ export declare const genSymbol: string;
@@ -2,27 +2,34 @@ import { Country, CountryCurrency, CountryTax } from "@artisan-commerce/types";
2
2
  /**
3
3
  * Generates CountryCurrency object with random data.
4
4
  *
5
- * @param {Partial<CountryCurrency>} overrides Properties to override a {@link CountryCurrency}
5
+ * @since 0.5.14
6
+ * @param {Partial<CountryCurrency>} overrides Properties to override
7
+ * a {@link CountryCurrency}
6
8
  * @returns {CountryCurrency} A {@link CountryCurrency} object
7
9
  */
8
10
  export declare const buildCountryCurrency: (overrides?: Partial<CountryCurrency>) => CountryCurrency;
9
11
  /**
10
12
  * Generates CountryTax object with random data.
11
13
  *
12
- * @param {Partial<CountryTax>} overrides Properties to override a {@link CountryTax}
14
+ * @since 0.5.14
15
+ * @param {Partial<CountryTax>} overrides Properties to override a
16
+ * {@link CountryTax}
13
17
  * @returns {CountryTax} A {@link CountryTax} object
14
18
  */
15
19
  export declare const buildCountryTax: (overrides?: Partial<CountryTax>) => CountryTax;
16
20
  /**
17
21
  * Generates a list of CountryTax objects with random data.
18
22
  *
23
+ * @since 0.5.14
19
24
  * @param {number} quantity The number of objects to be generated
20
- * @returns {CountryTax[]} An array of categories objects, see {@link CountryTax}
25
+ * @returns {CountryTax[]} An array of categories objects,
26
+ * see {@link CountryTax}
21
27
  */
22
28
  export declare const genCountryTax: (quantity?: number | undefined) => CountryTax[];
23
29
  /**
24
30
  * Generates Country object with random data.
25
31
  *
32
+ * @since 0.5.14
26
33
  * @param {Partial<Country>} overrides Properties to override a {@link Country}
27
34
  * @returns {Country} A {@link Country} object
28
35
  */
@@ -30,6 +37,7 @@ export declare const buildCountry: (overrides?: Partial<Country>) => Country;
30
37
  /**
31
38
  * Generates a list of countries objects with random data.
32
39
  *
40
+ * @since 0.5.14
33
41
  * @param {number} quantity The number of objects to be generated
34
42
  * @returns An array of countries objects, see {@link Country}
35
43
  */
@@ -3,6 +3,7 @@ import { Benefit, Award } from "@artisan-commerce/types";
3
3
  /**
4
4
  * Generates Benefit object with random data.
5
5
  *
6
+ * @since 0.5.14
6
7
  * @param {Partial<Benefit>} overrides Properties to override a {@link Benefit}
7
8
  * @returns {Benefit} A {@link Benefit} object
8
9
  */
@@ -10,6 +11,7 @@ export declare const buildBenefit: (overrides?: Partial<Benefit>) => Benefit;
10
11
  /**
11
12
  * Generates a list of Benefit objects with random data.
12
13
  *
14
+ * @since 0.5.14
13
15
  * @param {number} quantity The number of objects to be generated
14
16
  * @returns {Benefit[]} An array of Benefit objects, see {@link Benefit}
15
17
  */
@@ -17,6 +19,7 @@ export declare const genBenefits: (quantity?: number | undefined) => Benefit[];
17
19
  /**
18
20
  * Generates Award object with random data.
19
21
  *
22
+ * @since 0.5.14
20
23
  * @param {Partial<>} overrides Properties to override a {@link Award}
21
24
  * @returns {Award} A {@link Award} object
22
25
  */
@@ -24,6 +27,7 @@ export declare const buildAward: (overrides?: Partial<Award>) => Award;
24
27
  /**
25
28
  * Generates a list of Award objects with random data.
26
29
  *
30
+ * @since 0.5.14
27
31
  * @param {number} quantity The number of objects to be generated
28
32
  * @returns {Award[]} An array of Award objects, see {@link Award}
29
33
  */
@@ -31,6 +35,7 @@ export declare const genAwards: (quantity?: number | undefined) => Award[];
31
35
  /**
32
36
  * Generates Wallet object with random data.
33
37
  *
38
+ * @since 0.5.14
34
39
  * @param {Partial<Wallet>} overrides Properties to override a {@link Wallet}
35
40
  * @returns {Wallet} A {@link Wallet} object
36
41
  */
@@ -38,6 +43,7 @@ export declare const buildWallet: (overrides?: Partial<Wallet>) => Wallet;
38
43
  /**
39
44
  * Generates a list of Wallet objects with random data.
40
45
  *
46
+ * @since 0.5.14
41
47
  * @param {number} quantity The number of objects to be generated
42
48
  * @returns {Wallet[]} An array of Wallet objects, see {@link Wallet}
43
49
  */
@@ -0,0 +1,178 @@
1
+ import { Workflow, StepWorkflow } from "@artisan-commerce/types";
2
+ import { StepWorkflowAdditionalInfo } from "@artisan-commerce/types";
3
+ import { StepWorkflowGroup } from "@artisan-commerce/types";
4
+ import { Issue } from "@artisan-commerce/types";
5
+ import { StepNotification } from "@artisan-commerce/types";
6
+ import { IssueAdditionalInfo, IssueHistory } from "@artisan-commerce/types";
7
+ import { WebhookWorkflow, TransitionWorkflow } from "@artisan-commerce/types";
8
+ /**
9
+ * Generates Issue object with random data.
10
+ *
11
+ * @since 0.5.15
12
+ * @param {Partial<Issue>} overrides Properties to override
13
+ * a {@link Issue}
14
+ * @returns {Issue} A {@link Issue} object
15
+ */
16
+ export declare const buildIssue: (overrides?: Partial<Issue>) => Issue;
17
+ /**
18
+ * Generates IssueAdditionalInfo object with random data.
19
+ *
20
+ * @since 0.5.15
21
+ * @param {Partial<IssueAdditionalInfo>} overrides Properties to override
22
+ * a {@link IssueAdditionalInfo}
23
+ * @returns {IssueAdditionalInfo} A {@link IssueAdditionalInfo} object
24
+ */
25
+ export declare const buildIssueAdditionalInfo: (overrides?: Partial<IssueAdditionalInfo>) => IssueAdditionalInfo;
26
+ /**
27
+ * Generates a list of IssueAdditionalInfo objects with random data.
28
+ *
29
+ * @since 0.5.15
30
+ * @param {number} quantity The number of objects to be generated
31
+ * @returns {IssueAdditionalInfo[]} An array of IssueAdditionalInfo objects,
32
+ * see {@link IssueAdditionalInfo}
33
+ */
34
+ export declare const genIssueAdditionalInfo: (quantity?: number | undefined) => IssueAdditionalInfo[];
35
+ /**
36
+ * Generates IssueHistory object with random data.
37
+ *
38
+ * @since 0.5.15
39
+ * @param {Partial<IssueHistory>} overrides Properties to override
40
+ * a {@link IssueHistory}
41
+ * @returns {IssueHistory} A {@link IssueHistory} object
42
+ */
43
+ export declare const buildIssueHistory: (overrides?: Partial<IssueHistory>) => IssueHistory;
44
+ /**
45
+ * Generates a list of IssueHistory objects with random data.
46
+ *
47
+ * @since 0.5.15
48
+ * @param {number} quantity The number of objects to be generated
49
+ * @returns {IssueHistory[]} An array of IssueHistory objects,
50
+ * see {@link IssueHistory}
51
+ */
52
+ export declare const genIssueHistory: (quantity?: number | undefined) => IssueHistory[];
53
+ /**
54
+ * Generates Workflow object with random data.
55
+ *
56
+ * @since 0.5.15
57
+ * @param {Partial<Workflow>} overrides Properties to override
58
+ * a {@link Workflow}
59
+ * @returns {Workflow} A {@link Workflow} object
60
+ */
61
+ export declare const buildWorkflow: (overrides?: Partial<Workflow>) => Workflow;
62
+ /**
63
+ * Generates a list of Workflow objects with random data.
64
+ *
65
+ * @since 0.5.15
66
+ * @param {number} quantity The number of objects to be generated
67
+ * @returns {Workflow[]} An array of Workflow objects, see {@link Workflow}
68
+ */
69
+ export declare const genWorkflows: (quantity?: number | undefined) => Workflow[];
70
+ /**
71
+ * Generates StepNotification object with random data.
72
+ *
73
+ * @since 0.5.15
74
+ * @param {Partial<StepNotification>} overrides Properties to override
75
+ * a {@link StepNotification}
76
+ * @returns {StepNotification} A {@link StepNotification} object
77
+ */
78
+ export declare const buildStepNotification: (overrides?: Partial<StepNotification>) => StepNotification;
79
+ /**
80
+ * Generates a list of StepNotification objects with random data.
81
+ *
82
+ * @since 0.5.15
83
+ * @param {number} quantity The number of objects to be generated
84
+ * @returns {StepNotification[]} An array of StepNotification objects,
85
+ * see {@link StepNotification}
86
+ */
87
+ export declare const genStepNotifications: (quantity?: number | undefined) => StepNotification[];
88
+ /**
89
+ * Generates StepWorkflow object with random data.
90
+ *
91
+ * @since 0.5.15
92
+ * @param {Partial<StepWorkflow>} overrides Properties to override
93
+ * a {@link StepWorkflow}
94
+ * @returns {StepWorkflow} A {@link StepWorkflow} object
95
+ */
96
+ export declare const buildStepWorkflow: (overrides?: Partial<StepWorkflow>) => StepWorkflow;
97
+ /**
98
+ * Generates a list of StepWorkflow objects with random data.
99
+ *
100
+ * @since 0.5.15
101
+ * @param {number} quantity The number of objects to be generated
102
+ * @returns {StepWorkflow[]} An array of StepWorkflow objects,
103
+ * see {@link StepWorkflow}
104
+ */
105
+ export declare const genStepWorkflows: (quantity?: number | undefined) => StepWorkflow[];
106
+ /**
107
+ * Generates WebhookWorkflow object with random data.
108
+ *
109
+ * @since 0.5.15
110
+ * @param {Partial<WebhookWorkflow>} overrides Properties to override
111
+ * a {@link WebhookWorkflow}
112
+ * @returns {WebhookWorkflow} A {@link WebhookWorkflow} object
113
+ */
114
+ export declare const buildWebhookWorkflow: (overrides?: Partial<WebhookWorkflow>) => WebhookWorkflow;
115
+ /**
116
+ * Generates a list of WebhookWorkflow objects with random data.
117
+ *
118
+ * @since 0.5.15
119
+ * @param {number} quantity The number of objects to be generated
120
+ * @returns {WebhookWorkflow[]} An array of WebhookWorkflow objects,
121
+ * see {@link WebhookWorkflow}
122
+ */
123
+ export declare const genWebhookWorkflows: (quantity?: number | undefined) => WebhookWorkflow[];
124
+ /**
125
+ * Generates StepWorkflowAdditionalInfo object with random data.
126
+ *
127
+ * @since 0.5.15
128
+ * @param {Partial<StepWorkflowAdditionalInfo>} overrides Properties to
129
+ * override a {@link StepWorkflowAdditionalInfo}
130
+ * @returns {StepWorkflowAdditionalInfo} A
131
+ * {@link StepWorkflowAdditionalInfo} object
132
+ */
133
+ export declare const buildStepWorkflowAdditionalInfo: (overrides?: Partial<StepWorkflowAdditionalInfo>) => StepWorkflowAdditionalInfo;
134
+ /**
135
+ * Generates a list of StepWorkflowAdditionalInfo objects with random data.
136
+ *
137
+ * @since 0.5.15
138
+ * @param {number} quantity The number of objects to be generated
139
+ * @returns {StepWorkflowAdditionalInfo[]} An array of
140
+ * StepWorkflowAdditionalInfo objects, see {@link StepWorkflowAdditionalInfo}
141
+ */
142
+ export declare const genStepWorkflowAdditionalInfos: (quantity?: number | undefined) => StepWorkflowAdditionalInfo[];
143
+ /**
144
+ * Generates StepWorkflowGroup object with random data.
145
+ *
146
+ * @since 0.5.15
147
+ * @param {Partial<StepWorkflowGroup>} overrides Properties to override
148
+ * a {@link StepWorkflowGroup}
149
+ * @returns {StepWorkflowGroup} A {@link StepWorkflowGroup} object
150
+ */
151
+ export declare const buildStepWorkflowGroup: (overrides?: Partial<StepWorkflowGroup>) => StepWorkflowGroup;
152
+ /**
153
+ * Generates a list of StepWorkflowGroup objects with random data.
154
+ *
155
+ * @since 0.5.15
156
+ * @param {number} quantity The number of objects to be generated
157
+ * @returns {StepWorkflowGroup[]} An array of StepWorkflowGroup objects,
158
+ * see {@link StepWorkflowGroup}
159
+ */
160
+ export declare const genStepWorkflowGroups: (quantity?: number | undefined) => StepWorkflowGroup[];
161
+ /**
162
+ * Generates TransitionWorkflow object with random data.
163
+ *
164
+ * @since 0.5.15
165
+ * @param {Partial<TransitionWorkflow>} overrides Properties to override
166
+ * a {@link TransitionWorkflow}
167
+ * @returns {TransitionWorkflow} A {@link TransitionWorkflow} object
168
+ */
169
+ export declare const buildTransitionWorkflow: (overrides?: Partial<TransitionWorkflow>) => TransitionWorkflow;
170
+ /**
171
+ * Generates a list of TransitionWorkflow objects with random data.
172
+ *
173
+ * @since 0.5.15
174
+ * @param {number} quantity The number of objects to be generated
175
+ * @returns {TransitionWorkflow[]} An array of TransitionWorkflow objects,
176
+ * see {@link TransitionWorkflow}
177
+ */
178
+ export declare const genTransitionWorkflows: (quantity?: number | undefined) => TransitionWorkflow[];