webflow-api 1.2.2 → 1.3.0

package/tests/fixtures/collection.fixture.ts

@@ -0,0 +1,374 @@
+export const CollectionFixture = {
+  list: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: [
+      {
+        _id: "580e63fc8c9a982ac9b8b745",
+        lastUpdated: "2016-10-24T19:42:38.929Z",
+        createdOn: "2016-10-24T19:41:48.349Z",
+        name: "Blog Posts",
+        slug: "post",
+        singularName: "Blog Post",
+      },
+      {
+        _id: "580e64088c9a982ac9b8b766",
+        lastUpdated: "2016-10-24T19:42:00.799Z",
+        createdOn: "2016-10-24T19:42:00.777Z",
+        name: "Authors",
+        slug: "author",
+        singularName: "Author",
+      },
+    ],
+  },
+  getOne: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+    },
+    response: {
+      _id: "580e63fc8c9a982ac9b8b745",
+      lastUpdated: "2016-10-24T19:42:38.929Z",
+      createdOn: "2016-10-24T19:41:48.349Z",
+      name: "Blog Posts",
+      slug: "post",
+      singularName: "Blog Post",
+      fields: [
+        {
+          id: "7f62a9781291109b9e428fb47239fd35",
+          editable: true,
+          required: false,
+          type: "RichText",
+          slug: "post-body",
+          name: "Post Body",
+        },
+        {
+          validations: {
+            singleLine: false,
+          },
+          id: "ac4ffead755a78c710c44042f528b073",
+          helpText: "A summary of the blog post that appears on blog post grid",
+          editable: true,
+          required: false,
+          type: "PlainText",
+          slug: "post-summary",
+          name: "Post Summary",
+        },
+        {
+          id: "ba1cfbdaa6b38b8e95e9b5063da8a5bd",
+          editable: true,
+          required: false,
+          type: "ImageRef",
+          slug: "main-image",
+          name: "Main Image",
+        },
+        {
+          id: "a8c6ea29b08cc5b5ef966908fa1deae2",
+          helpText: "Smaller version of main image that is used on blog post grid",
+          editable: true,
+          required: false,
+          type: "ImageRef",
+          slug: "thumbnail-image",
+          name: "Thumbnail image",
+        },
+        {
+          id: "87e79a644a6fb5729940ec24e0012f01",
+          editable: true,
+          required: false,
+          type: "Set",
+          innerType: "ImageRef",
+          slug: "picture-gallery",
+          name: "Picture Gallery",
+        },
+        {
+          id: "1e54974d97181032d3206ea021668e5f",
+          editable: true,
+          required: false,
+          type: "Bool",
+          slug: "featured",
+          name: "Featured?",
+        },
+        {
+          id: "648463cbc042ab079c2b99430a398ae5",
+          editable: true,
+          required: false,
+          type: "Color",
+          slug: "color",
+          name: "Color",
+        },
+        {
+          validations: {
+            collectionId: "580e64088c9a982ac9b8b766",
+          },
+          id: "ea9067c48edee510de71fe503fa2fb51",
+          editable: true,
+          required: false,
+          type: "ItemRef",
+          slug: "author",
+          name: "Author",
+        },
+        {
+          validations: {
+            maxLength: 256,
+          },
+          id: "60c0667e27b6d5a6daedec3a641265f6",
+          editable: true,
+          required: true,
+          type: "PlainText",
+          slug: "name",
+          name: "Name",
+        },
+        {
+          validations: {
+            messages: {
+              maxLength: "Must be less than 256 characters",
+              pattern: "Must be alphanumerical and not contain any spaces or special characters",
+            },
+            pattern: {},
+            maxLength: 256,
+          },
+          id: "8f0c953df91d10b767d66e1d7d00d631",
+          unique: true,
+          editable: true,
+          required: true,
+          type: "PlainText",
+          slug: "slug",
+          name: "Slug",
+        },
+        {
+          default: false,
+          id: "e4e92e700d70faffac6fa82ff2bfaece",
+          editable: true,
+          required: true,
+          type: "Bool",
+          slug: "_archived",
+          name: "Archived",
+        },
+        {
+          default: false,
+          id: "f2675b2ac4fcef746b24d4a320887ef8",
+          editable: true,
+          required: true,
+          type: "Bool",
+          slug: "_draft",
+          name: "Draft",
+        },
+        {
+          id: "0913a35d92208bdf8fbf3ed1e39b771e",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "created-on",
+          name: "Created On",
+        },
+        {
+          id: "3de04889465fe6d718e47b152ef5bb4d",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "updated-on",
+          name: "Updated On",
+        },
+        {
+          id: "2a3cd866d5dbb294896130b233218626",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "published-on",
+          name: "Published On",
+        },
+        {
+          id: "62c18561b9e89517751c6d8712d48f91",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "created-by",
+          name: "Created By",
+        },
+        {
+          id: "50918093b4e4d4eca1e83c25bcdc06a4",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "updated-by",
+          name: "Updated By",
+        },
+        {
+          id: "5c4587f18b32ef245daeaadfcba7860b",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "published-by",
+          name: "Published By",
+        },
+        {
+          id: "7f62a9781291109b9e428fb47239fd35",
+          editable: true,
+          required: false,
+          type: "RichText",
+          slug: "post-body",
+          name: "Post Body",
+        },
+        {
+          validations: {
+            singleLine: false,
+          },
+          id: "ac4ffead755a78c710c44042f528b073",
+          helpText: "A summary of the blog post that appears on blog post grid",
+          editable: true,
+          required: false,
+          type: "PlainText",
+          slug: "post-summary",
+          name: "Post Summary",
+        },
+        {
+          id: "ba1cfbdaa6b38b8e95e9b5063da8a5bd",
+          editable: true,
+          required: false,
+          type: "ImageRef",
+          slug: "main-image",
+          name: "Main Image",
+        },
+        {
+          id: "a8c6ea29b08cc5b5ef966908fa1deae2",
+          helpText: "Smaller version of main image that is used on blog post grid",
+          editable: true,
+          required: false,
+          type: "ImageRef",
+          slug: "thumbnail-image",
+          name: "Thumbnail image",
+        },
+        {
+          id: "87e79a644a6fb5729940ec24e0012f01",
+          editable: true,
+          required: false,
+          type: "Set",
+          innerType: "ImageRef",
+          slug: "picture-gallery",
+          name: "Picture Gallery",
+        },
+        {
+          id: "1e54974d97181032d3206ea021668e5f",
+          editable: true,
+          required: false,
+          type: "Bool",
+          slug: "featured",
+          name: "Featured?",
+        },
+        {
+          id: "648463cbc042ab079c2b99430a398ae5",
+          editable: true,
+          required: false,
+          type: "Color",
+          slug: "color",
+          name: "Color",
+        },
+        {
+          validations: {
+            collectionId: "580e64088c9a982ac9b8b766",
+          },
+          id: "ea9067c48edee510de71fe503fa2fb51",
+          editable: true,
+          required: false,
+          type: "ItemRef",
+          slug: "author",
+          name: "Author",
+        },
+        {
+          validations: {
+            maxLength: 256,
+          },
+          id: "60c0667e27b6d5a6daedec3a641265f6",
+          editable: true,
+          required: true,
+          type: "PlainText",
+          slug: "name",
+          name: "Name",
+        },
+        {
+          validations: {
+            messages: {
+              maxLength: "Must be less than 256 characters",
+              pattern: "Must be alphanumerical and not contain any spaces or special characters",
+            },
+            pattern: {},
+            maxLength: 256,
+          },
+          id: "8f0c953df91d10b767d66e1d7d00d631",
+          unique: true,
+          editable: true,
+          required: true,
+          type: "PlainText",
+          slug: "slug",
+          name: "Slug",
+        },
+        {
+          default: false,
+          id: "e4e92e700d70faffac6fa82ff2bfaece",
+          editable: true,
+          required: true,
+          type: "Bool",
+          slug: "_archived",
+          name: "Archived",
+        },
+        {
+          default: false,
+          id: "f2675b2ac4fcef746b24d4a320887ef8",
+          editable: true,
+          required: true,
+          type: "Bool",
+          slug: "_draft",
+          name: "Draft",
+        },
+        {
+          id: "0913a35d92208bdf8fbf3ed1e39b771e",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "created-on",
+          name: "Created On",
+        },
+        {
+          id: "3de04889465fe6d718e47b152ef5bb4d",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "updated-on",
+          name: "Updated On",
+        },
+        {
+          id: "2a3cd866d5dbb294896130b233218626",
+          editable: false,
+          required: false,
+          type: "Date",
+          slug: "published-on",
+          name: "Published On",
+        },
+        {
+          id: "62c18561b9e89517751c6d8712d48f91",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "created-by",
+          name: "Created By",
+        },
+        {
+          id: "50918093b4e4d4eca1e83c25bcdc06a4",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "updated-by",
+          name: "Updated By",
+        },
+        {
+          id: "5c4587f18b32ef245daeaadfcba7860b",
+          editable: false,
+          required: false,
+          type: "User",
+          slug: "published-by",
+          name: "Published By",
+        },
+      ],
+    },
+  },
+};

package/tests/fixtures/index.ts

@@ -0,0 +1,7 @@
+export * from "./collection.fixture";
+export * from "./webhook.fixture";
+export * from "./oauth.fixture";
+export * from "./meta.fixture";
+export * from "./site.fixture";
+export * from "./item.fixture";
+export * from "./user.fixture";

package/tests/fixtures/item.fixture.ts

@@ -0,0 +1,193 @@
+export const ItemFixture = {
+  list: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+    },
+    response: {
+      items: [
+        {
+          _archived: false,
+          _draft: false,
+          color: "#a98080",
+          name: "Exciting blog post title",
+          "post-body": "<p>Blog post contents...</p>",
+          "post-summary": "Summary of exciting blog post",
+          "main-image": {
+            fileId: "580e63fe8c9a982ac9b8b749",
+            url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+          },
+          slug: "exciting-post",
+          author: "580e640c8c9a982ac9b8b778",
+          "updated-on": "2016-11-15T22:45:32.647Z",
+          "updated-by": "Person_5660c5338e9d3b0bee3b86aa",
+          "created-on": "2016-11-15T22:45:32.647Z",
+          "created-by": "Person_5660c5338e9d3b0bee3b86aa",
+          "published-on": null,
+          "published-by": null,
+          _cid: "580e63fc8c9a982ac9b8b745",
+          _id: "582b900cba19143b2bb8a759",
+        },
+      ],
+      count: 1,
+      limit: 1,
+      offset: 0,
+      total: 5,
+    },
+  },
+  getOne: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      itemId: "582b900cba19143b2bb8a759",
+    },
+    response: {
+      items: [
+        {
+          _archived: false,
+          _draft: false,
+          color: "#a98080",
+          name: "Exciting blog post title",
+          "post-body": "<p>Blog post contents...</p>",
+          "post-summary": "Summary of exciting blog post",
+          "main-image": {
+            fileId: "580e63fe8c9a982ac9b8b749",
+            url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+          },
+          slug: "exciting-post",
+          author: "580e640c8c9a982ac9b8b778",
+          "updated-on": "2016-11-15T22:45:32.647Z",
+          "updated-by": "Person_5660c5338e9d3b0bee3b86aa",
+          "created-on": "2016-11-15T22:45:32.647Z",
+          "created-by": "Person_5660c5338e9d3b0bee3b86aa",
+          "published-on": null,
+          "published-by": null,
+          _cid: "580e63fc8c9a982ac9b8b745",
+          _id: "582b900cba19143b2bb8a759",
+        },
+      ],
+      count: 1,
+      limit: 1,
+      offset: 0,
+      total: 5,
+    },
+  },
+  update: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      itemId: "582b900cba19143b2bb8a759",
+      fields: {
+        _archived: false,
+        _draft: false,
+        color: "#a98080",
+        name: "Exciting blog post title",
+        "post-body": "<p>Blog post contents...</p>",
+        "post-summary": "Summary of exciting blog post",
+        "main-image": {
+          fileId: "580e63fe8c9a982ac9b8b749",
+          url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+        },
+        slug: "exciting-post",
+      },
+    },
+    response: {
+      _archived: false,
+      _draft: false,
+      color: "#a98080",
+      name: "Exciting blog post title",
+      "post-body": "<p>Blog post contents...</p>",
+      "post-summary": "Summary of exciting blog post",
+      "main-image": {
+        fileId: "580e63fe8c9a982ac9b8b749",
+        url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+      },
+      slug: "exciting-post",
+      author: "580e640c8c9a982ac9b8b778",
+      "updated-on": "2016-11-15T22:45:32.647Z",
+      "updated-by": "Person_5660c5338e9d3b0bee3b86aa",
+      "created-on": "2016-11-15T22:45:32.647Z",
+      "created-by": "Person_5660c5338e9d3b0bee3b86aa",
+      "published-on": null,
+      "published-by": null,
+      _cid: "580e63fc8c9a982ac9b8b745",
+      _id: "582b900cba19143b2bb8a759",
+    },
+  },
+  create: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      fields: {
+        _archived: false,
+        _draft: false,
+        color: "#a98080",
+        name: "Exciting blog post title",
+        "post-body": "<p>Blog post contents...</p>",
+        "post-summary": "Summary of exciting blog post",
+        "main-image": {
+          fileId: "580e63fe8c9a982ac9b8b749",
+          url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+        },
+        slug: "exciting-post",
+      },
+    },
+    response: {
+      _archived: false,
+      _draft: false,
+      color: "#a98080",
+      name: "Exciting blog post title",
+      "post-body": "<p>Blog post contents...</p>",
+      "post-summary": "Summary of exciting blog post",
+      "main-image": {
+        fileId: "580e63fe8c9a982ac9b8b749",
+        url: "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg",
+      },
+      slug: "exciting-post",
+      author: "580e640c8c9a982ac9b8b778",
+      "updated-on": "2016-11-15T22:45:32.647Z",
+      "updated-by": "Person_5660c5338e9d3b0bee3b86aa",
+      "created-on": "2016-11-15T22:45:32.647Z",
+      "created-by": "Person_5660c5338e9d3b0bee3b86aa",
+      "published-on": null,
+      "published-by": null,
+      _cid: "580e63fc8c9a982ac9b8b745",
+      _id: "582b900cba19143b2bb8a759",
+    },
+  },
+  publish: {
+    parameters: {
+      live: true,
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      itemIds: ["62aa37923cf7a9de1ca4469c", "62aa37923cf7a9de1ca44697", "62aa37923cf7a9de1ca44696"],
+    },
+    response: {
+      publishedItemIds: [
+        "62aa37923cf7a9de1ca4469c",
+        "62aa37923cf7a9de1ca44697",
+        "62aa37923cf7a9de1ca44696",
+      ],
+      errors: [],
+    },
+  },
+  unpublish: {
+    parameters: {
+      live: true,
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      itemIds: ["62aa37923cf7a9de1ca4469c", "62aa37923cf7a9de1ca44697", "62aa37923cf7a9de1ca44696"],
+    },
+    response: {
+      deletedItemIds: [
+        "62aa37923cf7a9de1ca4469c",
+        "62aa37923cf7a9de1ca44697",
+        "62aa37923cf7a9de1ca44696",
+      ],
+      errors: [],
+    },
+  },
+  remove: {
+    parameters: {
+      collectionId: "580e63fc8c9a982ac9b8b745",
+      itemId: "582b900cba19143b2bb8a759",
+    },
+    response: {
+      deleted: 1,
+    },
+  },
+};

package/tests/fixtures/meta.fixture.ts

@@ -0,0 +1,34 @@
+export const MetaFixture = {
+  installer: {
+    response: {
+      user: {
+        _id: "545bbecb7bdd6769632504a7",
+        email: "some@email.com",
+        firstName: "Some",
+        lastName: "One",
+      },
+    },
+  },
+  info: {
+    response: {
+      _id: "55818d58616600637b9a5786",
+      createdOn: "2016-10-03T23:12:00.755Z",
+      grantType: "authorization_code",
+      lastUsed: "2016-10-10T21:41:12.736Z",
+      sites: ["62f3b1f7eafac55d0c64ef91"],
+      orgs: ["551ad253f0a9c0686f71ed08"],
+      workspaces: [],
+      users: ["545bbecb7bdd6769632504a7"],
+      rateLimit: 60,
+      status: "confirmed",
+      application: {
+        _id: "55131cd036c09f7d07883dfc",
+        description: "OAuth Testing Application",
+        homepage: "https://webflow.com",
+        name: "Test App",
+        owner: "545bbecb7bdd6769632504a7",
+        ownerType: "Person",
+      },
+    },
+  },
+};

package/tests/fixtures/oauth.fixture.ts

@@ -0,0 +1,38 @@
+export const OAuthFixture = {
+  authorize: {
+    parameters: {
+      client_id: "6287ec36a841b25637c663de",
+      redirect_uri: "https://www.webflowers.com",
+      response_type: "code",
+      state: "1234567890",
+    },
+    response: {
+      code: "6287ec36a841b25637c663de",
+    },
+  },
+  access_token: {
+    path: "/oauth/access_token",
+    parameters: {
+      client_id: "6287ec36a841b25637c663de",
+      client_secret: "6287ec36a841b25637c663de",
+      code: "6287ec36a841b25637c663de",
+      grant_type: "authorization_code",
+      redirect_uri: "https://www.webflowers.com",
+    },
+    response: {
+      access_token: "6287ec36a841b25637c663de",
+      token_type: "bearer",
+    },
+  },
+  revoke_token: {
+    path: "/oauth/revoke_authorization",
+    parameters: {
+      client_id: "6287ec36a841b25637c663de",
+      client_secret: "6287ec36a841b25637c663de",
+      access_token: "6287ec36a841b25637c663de",
+    },
+    response: {
+      didRevoke: true,
+    },
+  },
+};