clayful-lib-spec

[ { "className": "Brand", "modelName": "brand", "pathName": "brands", "apis": [ { "module": "brand.list", "httpMethod": "GET", "path": "/v1/brands", "modelName": "brand", "className": "Brand", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "brand.count", "httpMethod": "GET", "path": "/v1/brands/count", "modelName": "brand", "className": "Brand", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "brand.get", "httpMethod": "GET", "path": "/v1/brands/{brandId}", "modelName": "brand", "className": "Brand", "method": "get", "arguments": [ "brandId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "brand.pullFromMetafield", "httpMethod": "POST", "path": "/v1/brands/{brandId}/meta/{field}/pull", "modelName": "brand", "className": "Brand", "method": "pullFromMetafield", "arguments": [ "brandId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "brand.increaseMetafield", "httpMethod": "POST", "path": "/v1/brands/{brandId}/meta/{field}/inc", "modelName": "brand", "className": "Brand", "method": "increaseMetafield", "arguments": [ "brandId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "brand.pushToMetafield", "httpMethod": "POST", "path": "/v1/brands/{brandId}/meta/{field}/push", "modelName": "brand", "className": "Brand", "method": "pushToMetafield", "arguments": [ "brandId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "brand.deleteMetafield", "httpMethod": "DELETE", "path": "/v1/brands/{brandId}/meta/{field}", "modelName": "brand", "className": "Brand", "method": "deleteMetafield", "arguments": [ "brandId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Cart", "modelName": "cart", "pathName": "", "apis": [ { "module": "cart.countItemsForMe", "httpMethod": "GET", "path": "/v1/me/cart/items/count", "modelName": "cart", "className": "Cart", "method": "countItemsForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "cart.countItems", "httpMethod": "GET", "path": "/v1/customers/{customerId}/cart/items/count", "modelName": "cart", "className": "Cart", "method": "countItems", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "cart.getForMe", "httpMethod": "POST", "path": "/v1/me/cart", "modelName": "cart", "className": "Cart", "method": "getForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false }, "withoutPayload": false, "optionalPayload": true, "usesFormData": false }, { "module": "cart.getAsNonRegistered", "httpMethod": "POST", "path": "/v1/customers/non-registered/cart", "modelName": "cart", "className": "Cart", "method": "getAsNonRegistered", "arguments": [], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.get", "httpMethod": "POST", "path": "/v1/customers/{customerId}/cart", "modelName": "cart", "className": "Cart", "method": "get", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": true, "usesFormData": false }, { "module": "cart.addItemForMe", "httpMethod": "POST", "path": "/v1/me/cart/items", "modelName": "cart", "className": "Cart", "method": "addItemForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.getAsNonRegisteredForMe", "httpMethod": "POST", "path": "/v1/me/non-registered/cart", "modelName": "cart", "className": "Cart", "method": "getAsNonRegisteredForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "non-registered" ], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.addItem", "httpMethod": "POST", "path": "/v1/customers/{customerId}/cart/items", "modelName": "cart", "className": "Cart", "method": "addItem", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.checkoutForMe", "httpMethod": "POST", "path": "/v1/me/cart/checkout/{type}", "modelName": "cart", "className": "Cart", "method": "checkoutForMe", "arguments": [ "type" ], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false }, "withoutPayload": false, "optionalPayload": true, "usesFormData": false }, { "module": "cart.checkoutAsNonRegistered", "httpMethod": "POST", "path": "/v1/customers/non-registered/cart/checkout/{type}", "modelName": "cart", "className": "Cart", "method": "checkoutAsNonRegistered", "arguments": [ "type" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.checkout", "httpMethod": "POST", "path": "/v1/customers/{customerId}/cart/checkout/{type}", "modelName": "cart", "className": "Cart", "method": "checkout", "arguments": [ "customerId", "type" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": true, "usesFormData": false }, { "module": "cart.checkoutAsNonRegisteredForMe", "httpMethod": "POST", "path": "/v1/me/non-registered/cart/checkout/{type}", "modelName": "cart", "className": "Cart", "method": "checkoutAsNonRegisteredForMe", "arguments": [ "type" ], "access": { "public": true, "private": true, "me": true, "customer": [ "non-registered" ], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.updateItemForMe", "httpMethod": "PUT", "path": "/v1/me/cart/items/{itemId}", "modelName": "cart", "className": "Cart", "method": "updateItemForMe", "arguments": [ "itemId" ], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.updateItem", "httpMethod": "PUT", "path": "/v1/customers/{customerId}/cart/items/{itemId}", "modelName": "cart", "className": "Cart", "method": "updateItem", "arguments": [ "customerId", "itemId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "cart.emptyForMe", "httpMethod": "DELETE", "path": "/v1/me/cart/items", "modelName": "cart", "className": "Cart", "method": "emptyForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "cart.empty", "httpMethod": "DELETE", "path": "/v1/customers/{customerId}/cart/items", "modelName": "cart", "className": "Cart", "method": "empty", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "cart.deleteItemForMe", "httpMethod": "DELETE", "path": "/v1/me/cart/items/{itemId}", "modelName": "cart", "className": "Cart", "method": "deleteItemForMe", "arguments": [ "itemId" ], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "cart.deleteItem", "httpMethod": "DELETE", "path": "/v1/customers/{customerId}/cart/items/{itemId}", "modelName": "cart", "className": "Cart", "method": "deleteItem", "arguments": [ "customerId", "itemId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Catalog", "modelName": "catalog", "pathName": "catalogs", "apis": [ { "module": "catalog.list", "httpMethod": "GET", "path": "/v1/catalogs", "modelName": "catalog", "className": "Catalog", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "catalog.count", "httpMethod": "GET", "path": "/v1/catalogs/count", "modelName": "catalog", "className": "Catalog", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "catalog.get", "httpMethod": "GET", "path": "/v1/catalogs/{catalogId}", "modelName": "catalog", "className": "Catalog", "method": "get", "arguments": [ "catalogId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "catalog.pullFromMetafield", "httpMethod": "POST", "path": "/v1/catalogs/{catalogId}/meta/{field}/pull", "modelName": "catalog", "className": "Catalog", "method": "pullFromMetafield", "arguments": [ "catalogId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "catalog.increaseMetafield", "httpMethod": "POST", "path": "/v1/catalogs/{catalogId}/meta/{field}/inc", "modelName": "catalog", "className": "Catalog", "method": "increaseMetafield", "arguments": [ "catalogId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "catalog.pushToMetafield", "httpMethod": "POST", "path": "/v1/catalogs/{catalogId}/meta/{field}/push", "modelName": "catalog", "className": "Catalog", "method": "pushToMetafield", "arguments": [ "catalogId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "catalog.deleteMetafield", "httpMethod": "DELETE", "path": "/v1/catalogs/{catalogId}/meta/{field}", "modelName": "catalog", "className": "Catalog", "method": "deleteMetafield", "arguments": [ "catalogId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Collection", "modelName": "collection", "pathName": "collections", "apis": [ { "module": "collection.list", "httpMethod": "GET", "path": "/v1/collections", "modelName": "collection", "className": "Collection", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "collection.count", "httpMethod": "GET", "path": "/v1/collections/count", "modelName": "collection", "className": "Collection", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "collection.get", "httpMethod": "GET", "path": "/v1/collections/{collectionId}", "modelName": "collection", "className": "Collection", "method": "get", "arguments": [ "collectionId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "collection.pullFromMetafield", "httpMethod": "POST", "path": "/v1/collections/{collectionId}/meta/{field}/pull", "modelName": "collection", "className": "Collection", "method": "pullFromMetafield", "arguments": [ "collectionId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "collection.increaseMetafield", "httpMethod": "POST", "path": "/v1/collections/{collectionId}/meta/{field}/inc", "modelName": "collection", "className": "Collection", "method": "increaseMetafield", "arguments": [ "collectionId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "collection.pushToMetafield", "httpMethod": "POST", "path": "/v1/collections/{collectionId}/meta/{field}/push", "modelName": "collection", "className": "Collection", "method": "pushToMetafield", "arguments": [ "collectionId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "collection.deleteMetafield", "httpMethod": "DELETE", "path": "/v1/collections/{collectionId}/meta/{field}", "modelName": "collection", "className": "Collection", "method": "deleteMetafield", "arguments": [ "collectionId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Country", "modelName": "country", "pathName": "countries", "apis": [ { "module": "country.list", "httpMethod": "GET", "path": "/v1/countries", "modelName": "country", "className": "Country", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "country.count", "httpMethod": "GET", "path": "/v1/countries/count", "modelName": "country", "className": "Country", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "country.get", "httpMethod": "GET", "path": "/v1/countries/{countryId}", "modelName": "country", "className": "Country", "method": "get", "arguments": [ "countryId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Coupon", "modelName": "coupon", "pathName": "coupons", "apis": [ { "module": "coupon.list", "httpMethod": "GET", "path": "/v1/coupons", "modelName": "coupon", "className": "Coupon", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "coupon.count", "httpMethod": "GET", "path": "/v1/coupons/count", "modelName": "coupon", "className": "Coupon", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "coupon.get", "httpMethod": "GET", "path": "/v1/coupons/{couponId}", "modelName": "coupon", "className": "Coupon", "method": "get", "arguments": [ "couponId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "coupon.pushToMetafield", "httpMethod": "POST", "path": "/v1/coupons/{couponId}/meta/{field}/push", "modelName": "coupon", "className": "Coupon", "method": "pushToMetafield", "arguments": [ "couponId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "coupon.increaseMetafield", "httpMethod": "POST", "path": "/v1/coupons/{couponId}/meta/{field}/inc", "modelName": "coupon", "className": "Coupon", "method": "increaseMetafield", "arguments": [ "couponId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "coupon.pullFromMetafield", "httpMethod": "POST", "path": "/v1/coupons/{couponId}/meta/{field}/pull", "modelName": "coupon", "className": "Coupon", "method": "pullFromMetafield", "arguments": [ "couponId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "coupon.deleteMetafield", "httpMethod": "DELETE", "path": "/v1/coupons/{couponId}/meta/{field}", "modelName": "coupon", "className": "Coupon", "method": "deleteMetafield", "arguments": [ "couponId", "field" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Currency", "modelName": "currency", "pathName": "currencies", "apis": [ { "module": "currency.list", "httpMethod": "GET", "path": "/v1/currencies", "modelName": "currency", "className": "Currency", "method": "list", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "currency.count", "httpMethod": "GET", "path": "/v1/currencies/count", "modelName": "currency", "className": "Currency", "method": "count", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } }, { "module": "currency.get", "httpMethod": "GET", "path": "/v1/currencies/{currencyId}", "modelName": "currency", "className": "Currency", "method": "get", "arguments": [ "currencyId" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false } } ] }, { "className": "Customer", "modelName": "customer", "pathName": "customers", "apis": [ { "module": "customer.list", "httpMethod": "GET", "path": "/v1/customers", "modelName": "customer", "className": "Customer", "method": "list", "arguments": [], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.getMe", "httpMethod": "GET", "path": "/v1/me", "modelName": "customer", "className": "Customer", "method": "getMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "customer.isAuthenticated", "httpMethod": "GET", "path": "/v1/customers/auth", "modelName": "customer", "className": "Customer", "method": "isAuthenticated", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [], "module": false } }, { "module": "customer.count", "httpMethod": "GET", "path": "/v1/customers/count", "modelName": "customer", "className": "Customer", "method": "count", "arguments": [], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.get", "httpMethod": "GET", "path": "/v1/customers/{customerId}", "modelName": "customer", "className": "Customer", "method": "get", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.listCouponsForMe", "httpMethod": "GET", "path": "/v1/me/coupons", "modelName": "customer", "className": "Customer", "method": "listCouponsForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "customer.listCoupons", "httpMethod": "GET", "path": "/v1/customers/{customerId}/coupons", "modelName": "customer", "className": "Customer", "method": "listCoupons", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.countCouponsForMe", "httpMethod": "GET", "path": "/v1/me/coupons/count", "modelName": "customer", "className": "Customer", "method": "countCouponsForMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "registered" ], "module": false } }, { "module": "customer.countCoupons", "httpMethod": "GET", "path": "/v1/customers/{customerId}/coupons/count", "modelName": "customer", "className": "Customer", "method": "countCoupons", "arguments": [ "customerId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.listByFlagVotes", "httpMethod": "GET", "path": "/v1/{voteModel}/{voteModelId}/flags/customers", "modelName": "customer", "className": "Customer", "method": "listByFlagVotes", "arguments": [ "voteModel", "voteModelId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.listByFlagVotes", "httpMethod": "GET", "path": "/v1/{voteModel}/{voteModelId}/flags/customers", "modelName": "customer", "className": "Customer", "method": "listByFlagVotes", "arguments": [ "voteModel", "voteModelId" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.listByHelpVotes", "httpMethod": "GET", "path": "/v1/{voteModel}/{voteModelId}/helped/{upDown}/customers", "modelName": "customer", "className": "Customer", "method": "listByHelpVotes", "arguments": [ "voteModel", "voteModelId", "upDown" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.listByHelpVotes", "httpMethod": "GET", "path": "/v1/{voteModel}/{voteModelId}/helped/{upDown}/customers", "modelName": "customer", "className": "Customer", "method": "listByHelpVotes", "arguments": [ "voteModel", "voteModelId", "upDown" ], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false } }, { "module": "customer.create", "httpMethod": "POST", "path": "/v1/customers", "modelName": "customer", "className": "Customer", "method": "create", "arguments": [], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.createMe", "httpMethod": "POST", "path": "/v1/me", "modelName": "customer", "className": "Customer", "method": "createMe", "arguments": [], "access": { "public": true, "private": true, "me": true, "customer": [ "non-registered" ], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.authenticate", "httpMethod": "POST", "path": "/v1/customers/auth", "modelName": "customer", "className": "Customer", "method": "authenticate", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.createVerification", "httpMethod": "POST", "path": "/v1/customers/verifications", "modelName": "customer", "className": "Customer", "method": "createVerification", "arguments": [], "access": { "public": false, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.authenticateBy3rdParty", "httpMethod": "POST", "path": "/v1/customers/auth/{vendor}", "modelName": "customer", "className": "Customer", "method": "authenticateBy3rdParty", "arguments": [ "vendor" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": true, "optionalPayload": false, "usesFormData": false }, { "module": "customer.requestVerificationEmail", "httpMethod": "POST", "path": "/v1/customers/verifications/emails", "modelName": "customer", "className": "Customer", "method": "requestVerificationEmail", "arguments": [], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.requestVerification", "httpMethod": "POST", "path": "/v1/customers/verifications/{channelSlug}", "modelName": "customer", "className": "Customer", "method": "requestVerification", "arguments": [ "channelSlug" ], "access": { "public": true, "private": true, "me": false, "customer": [], "module": false }, "withoutPayload": false, "optionalPayload": false, "usesFormData": false }, { "module": "customer.addCoupon", "httpMethod": "POST", "path": "/v1/customers/{customerId}/coupons", "modelName": "customer", "className": "Customer", "method": "addCoupon", "arguments": [ "customerId" ], "access": { "public": f