webflow-api 1.1.2 → 1.2.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.
Files changed (70) hide show
  1. package/dist/api/collection.d.ts +85 -24
  2. package/dist/api/collection.js +88 -29
  3. package/dist/api/index.d.ts +7 -7
  4. package/dist/api/index.js +9 -19
  5. package/dist/api/item.d.ts +141 -107
  6. package/dist/api/item.js +145 -125
  7. package/dist/api/meta.d.ts +16 -14
  8. package/dist/api/meta.js +20 -19
  9. package/dist/api/oauth.d.ts +38 -36
  10. package/dist/api/oauth.js +59 -59
  11. package/dist/api/site.d.ts +118 -43
  12. package/dist/api/site.js +131 -53
  13. package/dist/{wrapper/membership.d.ts → api/user.d.ts} +59 -47
  14. package/dist/api/user.js +103 -0
  15. package/dist/api/webhook.d.ts +77 -55
  16. package/dist/api/webhook.js +74 -61
  17. package/dist/core/error.d.ts +2 -0
  18. package/dist/core/error.js +8 -1
  19. package/dist/core/index.d.ts +2 -2
  20. package/dist/core/index.js +2 -2
  21. package/dist/core/response.d.ts +32 -0
  22. package/dist/core/response.js +26 -0
  23. package/dist/{webflow.d.ts → core/webflow.d.ts} +56 -59
  24. package/dist/{webflow.js → core/webflow.js} +101 -68
  25. package/dist/index.d.ts +1 -1
  26. package/dist/index.js +2 -2
  27. package/package.json +2 -4
  28. package/src/api/collection.ts +102 -35
  29. package/src/api/index.ts +7 -7
  30. package/src/api/item.ts +207 -176
  31. package/src/api/meta.ts +19 -18
  32. package/src/api/oauth.ts +62 -74
  33. package/src/api/site.ts +158 -55
  34. package/src/api/user.ts +152 -0
  35. package/src/api/webhook.ts +97 -80
  36. package/src/core/error.ts +8 -0
  37. package/src/core/index.ts +2 -2
  38. package/src/core/response.ts +50 -0
  39. package/src/{webflow.ts → core/webflow.ts} +131 -145
  40. package/src/index.ts +1 -1
  41. package/yarn.lock +0 -5
  42. package/dist/api/membership.d.ts +0 -114
  43. package/dist/api/membership.js +0 -96
  44. package/dist/core/client.d.ts +0 -27
  45. package/dist/core/client.js +0 -60
  46. package/dist/core/options.d.ts +0 -8
  47. package/dist/core/options.js +0 -5
  48. package/dist/wrapper/collection.d.ts +0 -85
  49. package/dist/wrapper/collection.js +0 -94
  50. package/dist/wrapper/index.d.ts +0 -6
  51. package/dist/wrapper/index.js +0 -22
  52. package/dist/wrapper/item.d.ts +0 -140
  53. package/dist/wrapper/item.js +0 -153
  54. package/dist/wrapper/membership.js +0 -123
  55. package/dist/wrapper/response.d.ts +0 -16
  56. package/dist/wrapper/response.js +0 -17
  57. package/dist/wrapper/site.d.ts +0 -168
  58. package/dist/wrapper/site.js +0 -191
  59. package/dist/wrapper/webhook.d.ts +0 -78
  60. package/dist/wrapper/webhook.js +0 -82
  61. package/src/api/membership.ts +0 -155
  62. package/src/core/client.ts +0 -82
  63. package/src/core/options.ts +0 -9
  64. package/src/wrapper/collection.ts +0 -115
  65. package/src/wrapper/index.ts +0 -6
  66. package/src/wrapper/item.ts +0 -218
  67. package/src/wrapper/membership.ts +0 -163
  68. package/src/wrapper/response.ts +0 -25
  69. package/src/wrapper/site.ts +0 -228
  70. package/src/wrapper/webhook.ts +0 -116
@@ -1,116 +0,0 @@
1
- import { Client, QueryString } from "../core";
2
- import { ResponseWrapper } from ".";
3
- import { Webhook } from "../api";
4
-
5
- export type CreateWebhookParams = {
6
- url: string;
7
- siteId: string;
8
- triggerType: string;
9
- filter?: Webhook.Filter;
10
- };
11
-
12
- export class WebhookWrapper implements Webhook.IWebhook {
13
- triggerType: Webhook.TriggerType;
14
- triggerId: string;
15
- createdOn: string;
16
- lastUsed?: string;
17
- site: string;
18
- _id: string;
19
- filter?: {
20
- name: string;
21
- };
22
-
23
- constructor(private client: Client, webhook: Webhook.IWebhook) {
24
- Object.assign(this, webhook);
25
- }
26
-
27
- /**************************************************************
28
- * Static Methods
29
- **************************************************************/
30
-
31
- /**
32
- * Get a Webhook
33
- * @param client The Webflow client
34
- * @param params The Webhook params
35
- * @param params.siteId The Site ID
36
- * @param params.webhookId The Webhook ID
37
- * @returns The Webhook
38
- */
39
- static async getOne(
40
- client: Client,
41
- { siteId, webhookId }: { siteId: string; webhookId: string }
42
- ) {
43
- const res = await Webhook.getOne(client, { siteId, webhookId });
44
- const webhook = new WebhookWrapper(client, res.data);
45
- return ResponseWrapper<typeof webhook>(res, webhook);
46
- }
47
-
48
- /**
49
- * List Webhooks
50
- * @param client The Webflow client
51
- * @param param1 The Webhook params
52
- * @param param1.siteId The Site ID
53
- * @param params Query string params (optional)
54
- * @returns A list of Webhooks
55
- */
56
- static async list(
57
- client: Client,
58
- { siteId }: { siteId: string },
59
- params?: QueryString
60
- ) {
61
- const res = await Webhook.list(client, { siteId }, params);
62
- const webhooks = res.data.map((w) => new WebhookWrapper(client, w));
63
- return ResponseWrapper<typeof webhooks>(res, webhooks);
64
- }
65
-
66
- /**
67
- * Remove a Webhook
68
- * @param client The Webflow client
69
- * @param params The Webhook params
70
- * @param params.siteId The Site ID
71
- * @param params.webhookId The Webhook ID
72
- * @returns The result of the removal
73
- */
74
- static async remove(
75
- client: Client,
76
- { siteId, webhookId }: { siteId: string; webhookId: string }
77
- ) {
78
- const res = await Webhook.remove(client, { siteId, webhookId });
79
- return ResponseWrapper<typeof res.data>(res);
80
- }
81
-
82
- /**
83
- * Create a Webhook
84
- * @param client The Webflow client
85
- * @param param1 The Webhook params
86
- * @param param1.siteId The Site ID
87
- * @param param1.url The URL to send the Webhook to
88
- * @param param1.triggerType The event to trigger the Webhook
89
- * @param param1.filter The filter to use (optional: form_submission only)
90
- * @returns The created Webhook
91
- */
92
- static async create(
93
- client: Client,
94
- { triggerType, siteId, filter, url }: CreateWebhookParams
95
- ) {
96
- const args = { triggerType, siteId, filter, url };
97
- const res = await Webhook.create(client, args);
98
- const _webhook = new WebhookWrapper(client, res.data);
99
- return ResponseWrapper<typeof _webhook>(res, _webhook);
100
- }
101
-
102
- /**************************************************************
103
- * Instance Methods
104
- **************************************************************/
105
-
106
- /**
107
- * Remove a Webhook
108
- * @returns The result of the removal
109
- */
110
- async remove() {
111
- return WebhookWrapper.remove(this.client, {
112
- webhookId: this._id,
113
- siteId: this.site,
114
- });
115
- }
116
- }