{ "openapi": "3.1.0", "info": { "title": "OpenAPI", "version": "" }, "servers": [ { "url": "https://api.fourthwall.com", "description": "Production server" } ], "paths": { "/open-api/v1.1/memberships/posts/{post_id}/pin": { "post": { "summary": "Pin Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "operationId": "pin-post" }, "delete": { "summary": "Unpin Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "operationId": "unpin-post" } }, "/open-api/v1.1/memberships/posts/polls": { "post": { "summary": "Create Poll Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Poll.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "options": { "type": "array", "items": { "type": "string", "maxLength": 80 }, "minItems": 2, "maxItems": 20 }, "poll_length": { "type": "object", "properties": { "days": { "type": "integer" }, "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "required": [ "days", "hours", "minutes" ] } }, "required": [ "attributes", "access", "notifications", "options", "poll_length" ], "openapi": true } } }, "required": true }, "operationId": "create-poll-post" } }, "/open-api/v1.1/memberships/posts/polls/{id}": { "put": { "summary": "Update Poll Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Poll.Update" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "attributes", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "update-poll-post" } }, "/open-api/v1.1/memberships/posts/texts": { "post": { "summary": "Create Text Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Text.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "attributes", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "create-text-post" } }, "/open-api/v1.1/memberships/posts/texts/{id}": { "put": { "summary": "Update Text Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Text.Update" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "attributes", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "update-text-post" } }, "/open-api/v1.1/memberships/posts/video_embeds": { "post": { "summary": "Create Video Embed Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.VideoEmbed.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "embed": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageDirectUploadData": { "type": "object", "properties": { "byteSize": { "type": "integer" }, "checksum": { "type": "string" } }, "required": [ "byteSize", "checksum" ] } }, "required": [ "attributes", "access", "embed", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "create-video-embed-post" } }, "/open-api/v1.1/memberships/posts/video_embeds/{id}": { "put": { "summary": "Update Video Embed Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Feed.Post.VideoEmbed.Update" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "core": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } } }, "required": [ "core" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "embed": { "type": "object", "properties": { "url": { "type": "string", "pattern": "(?-mix:^(?:https?:\\/\\/)?(?:www\\.)?youtu(?:\\.be|be\\.com)\\/(?:watch\\?v=|live\\/|shorts\\/)?([\\w-]{10,}))" } }, "required": [ "url" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageDirectUploadData": { "type": "object", "properties": { "byteSize": { "type": "integer" }, "checksum": { "type": "string" } }, "required": [ "byteSize", "checksum" ] }, "remove_thumbnail": { "type": "boolean" } }, "required": [ "attributes", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "update-video-embed-post" } }, "/open-api/v1.1/memberships/posts": { "get": { "summary": "List Posts", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search_query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "types[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ], "enum": [ "Text", "Poll", "Image", "Audio", "Video" ] } } }, { "name": "ids[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "integer", "null" ] } } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Published", "Scheduled", "All" ] } }, { "name": "tags_ids[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "integer", "null" ] } } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "posts": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Text" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Poll" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Audio" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Video" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.VideoEmbed" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image" } ], "discriminator": { "propertyName": "type" } } }, "pagination": { "$ref": "#/components/schemas/Response.V1.Pagination" } }, "required": [ "posts", "pagination" ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "operationId": "list-posts" } }, "/open-api/v1.1/memberships/posts/{id}": { "get": { "summary": "Get Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Text" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Poll" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Audio" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Video" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.VideoEmbed" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image" } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "operationId": "get-post" }, "delete": { "summary": "Delete Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "operationId": "delete-post" } }, "/open-api/v1.1/memberships/members": { "get": { "summary": "List Members", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search_query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tier_ids[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "integer", "null" ] } } }, { "name": "intervals[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ], "enum": [ "Month", "Year" ] } } }, { "name": "states[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ], "enum": [ "Active", "Expiring", "Former", "PastDue", "None", "FreeTrial" ] } } }, { "name": "member_ids[]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": [ "integer", "null" ] } } }, { "name": "gifted_by_others", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "tags": [ "Members" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Members" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "operationId": "list-members" } }, "/open-api/v1.1/memberships/members/{id}": { "get": { "summary": "Get Member", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Members" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Member" } } } } }, "operationId": "get-member" } }, "/open-api/v1.1/memberships/images": { "post": { "summary": "Create Image", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Resources" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Resource.Image.Google.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "byteSize": { "type": "integer" }, "checksum": { "type": "string" } }, "required": [ "byteSize", "checksum" ], "openapi": true } } }, "required": true }, "operationId": "create-image" } }, "/open-api/v1.1/memberships/images/{id}/confirm": { "patch": { "summary": "Confirm Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Resources" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "signedId": { "type": "string" } }, "required": [ "signedId" ], "openapi": true } } }, "required": true }, "operationId": "confirm-post" } }, "/open-api/v1.1/memberships/tags/posts": { "get": { "summary": "List Post Tags", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "query[field]", "in": "query", "description": "'Name' or 'Ids'", "required": false, "schema": { "type": "string" } }, { "name": "query[name]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query[ids][]", "in": "query", "style": "form", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } } ], "tags": [ "Tags" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Tag.Posts" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "operationId": "list-post-tags" }, "post": { "summary": "Create Post Tag", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Tags" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Id" } } } }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 30 }, "postsIds": { "type": "array", "items": { "type": "integer" }, "optional": true }, "thumbnailResourceId": { "type": "integer", "optional": true } }, "required": [ "name" ], "openapi": true } } }, "required": true }, "operationId": "create-post-tag" } }, "/open-api/v1.1/memberships/tags/posts/{id}": { "get": { "summary": "Get Post Tag", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Tags" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V1.Tag.PostWithPostsIds" } } } } }, "operationId": "get-post-tag" }, "patch": { "summary": "Update Post Tag", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Tags" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 30 }, "postsIds": { "type": "array", "items": { "type": "integer" }, "optional": true }, "thumbnailResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] } ], "optional": true } }, "required": [ "name" ], "openapi": true } } }, "required": true }, "operationId": "update-post-tag" }, "delete": { "summary": "Delete Post Tag", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Tags" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" } }, "operationId": "delete-post-tag" } }, "/open-api/v1.1/memberships/posts/audios": { "post": { "summary": "Create Audio Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Post.Audio.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 30 } }, "series": { "type": "array", "items": { "type": "object", "properties": {}, "required": [] } } }, "required": [ "title" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageResourceId": { "type": "integer" }, "mediaUrl": { "type": "string" }, "skipMediaUrlVerification": { "type": "boolean" } }, "required": [ "post", "access", "notifications", "imageResourceId" ], "openapi": true } } }, "required": true }, "operationId": "create-audio-post" } }, "/open-api/v1.1/memberships/posts/audios/{id}": { "patch": { "summary": "Update Audio Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Post.Audio.Update" } } } }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 30 } }, "series": { "type": "array", "items": { "type": "object", "properties": {}, "required": [] } } }, "required": [ "title" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] } ] }, "newMediaDirectUpload": { "type": "boolean" }, "mediaUrl": { "type": "string" } }, "required": [ "post", "access", "notifications", "imageResource" ], "openapi": true } } }, "required": true }, "operationId": "update-audio-post" } }, "/open-api/v1.1/memberships/posts/images": { "post": { "summary": "Create Image Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Id" } } } }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] }, "imageResources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "position": { "type": "integer" } }, "required": [ "id", "position" ] }, "minItems": 1, "maxItems": 100 }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "post", "imageResources", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "create-image-post" } }, "/open-api/v1.1/memberships/posts/images/{id}": { "put": { "summary": "Update Image Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "liveAt" ] }, "imageResources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "position": { "type": "integer" } }, "required": [ "id", "position" ] }, "minItems": 1, "maxItems": 100 }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "post", "imageResources", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "update-image-post" } }, "/open-api/v1.1/memberships/posts/videos": { "post": { "summary": "Create Video Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Post.Video.Create" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 30 } }, "series": { "type": "array", "items": { "type": "object", "properties": {}, "required": [] } }, "countryRestrictions": { "type": "array", "items": { "type": "string" } } }, "required": [ "title" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageResourceId": { "type": "integer" }, "subtitlesResourceId": { "type": "integer" }, "mediaUrl": { "type": "string" } }, "required": [ "post", "access", "notifications" ], "openapi": true } } }, "required": true }, "operationId": "create-video-post" } }, "/open-api/v1.1/memberships/posts/videos/{id}": { "patch": { "summary": "Update Video Post", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Posts" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Post.Video.Update" } } } }, "400": { "description": "Image was not found or the upload was not completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Custom" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 100000 }, "liveAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 30 } }, "series": { "type": "array", "items": { "type": "object", "properties": {}, "required": [] } }, "countryRestrictions": { "type": "array", "items": { "type": "string" } } }, "required": [ "title" ] }, "access": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MembersOnly", "Plans", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Request.Common.Id" } }, "price": { "type": "integer", "minimum": 300, "maximum": 50000 } }, "required": [ "type" ] }, "notifications": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "imageResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] } ] }, "subtitlesResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] } ] }, "newMediaDirectUpload": { "type": "boolean" }, "mediaUrl": { "type": "string" } }, "required": [ "post", "access", "notifications", "imageResource", "subtitlesResource" ], "openapi": true } } }, "required": true }, "operationId": "update-video-post" } }, "/open-api/v1.1/memberships/series/posts": { "get": { "summary": "List Post Series", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "postsType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "video", "audio" ] } } ], "tags": [ "Series" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Series.Posts" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "operationId": "list-post-series" }, "post": { "summary": "Create Post Series", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Series" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Id" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } }, "404": { "description": "" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "postsType": { "type": "string", "enum": [ "video", "audio" ] }, "description": { "type": "string", "maxLength": 2048 }, "coverImageResourceId": { "type": "integer" }, "thumbnailResourceId": { "type": "integer" }, "postsIds": { "type": "array", "items": { "type": "integer" } } }, "required": [ "title", "postsType", "description" ], "openapi": true } } }, "required": true }, "operationId": "create-post-series" } }, "/open-api/v1.1/memberships/series/posts/{id}": { "get": { "summary": "Get Post Series", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Series" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Series.Post" } } } } }, "operationId": "get-post-series" }, "put": { "summary": "Update Post Series", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Series" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3 }, "description": { "type": "string", "maxLength": 2048 }, "coverImageResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] } ] }, "thumbnailResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] } ] }, "postsIds": { "type": "array", "items": { "type": "integer" } } }, "required": [ "title", "description", "coverImageResource", "thumbnailResource" ], "openapi": true } } }, "required": true }, "operationId": "update-post-series" }, "delete": { "summary": "Delete Post Series", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Series" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" } }, "operationId": "delete-post-series" } }, "/open-api/v1.1/memberships/tiers": { "get": { "summary": "List Tiers", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Tiers" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Tiers.Paid.Collection" } } } } }, "operationId": "list-tiers" }, "post": { "summary": "Create Tier", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } } ], "tags": [ "Tiers" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Id" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "description": { "type": "string", "maxLength": 600 }, "imageResourceId": { "type": "integer" }, "pricesAutomaticallyConverted": { "type": "boolean" }, "askForShippingAddress": { "type": "boolean" }, "monthlyAmounts": { "type": "object", "properties": { "usd": { "type": "integer", "minimum": 100, "maximum": 150000000 }, "eur": { "type": "integer" }, "gbp": { "type": "integer" }, "cad": { "type": "integer" }, "aud": { "type": "integer" }, "nzd": { "type": "integer" }, "sek": { "type": "integer" }, "nok": { "type": "integer" }, "dkk": { "type": "integer" }, "pln": { "type": "integer" }, "jpy": { "type": "integer" }, "myr": { "type": "integer" }, "sgd": { "type": "integer" }, "mxn": { "type": "integer" } }, "required": [ "usd", "eur", "gbp", "cad", "aud", "nzd", "sek", "nok", "dkk", "pln", "jpy", "myr", "sgd", "mxn" ] }, "discount": { "type": "object", "properties": { "percentOff": { "type": "object", "properties": { "monthly": { "type": "integer", "minimum": 0, "maximum": 100 }, "annual": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "monthly" ] }, "timeLimited": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "required": [ "startDate", "endDate" ] } }, "required": [ "percentOff" ] }, "freeTrial": { "type": "boolean" } }, "required": [ "name", "description", "monthlyAmounts" ], "openapi": true } } }, "required": true }, "operationId": "create-tier" } }, "/open-api/v1.1/memberships/tiers/{id}": { "get": { "summary": "Get Tier", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Tiers" ], "security": [ { "oauth": [ "memberships_read" ] }, { "basicAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.V2.Tiers.Paid" } } } } }, "operationId": "get-tier" }, "patch": { "summary": "Update Tier", "parameters": [ { "name": "X-ShopId", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "tags": [ "Tiers" ], "security": [ { "oauth": [ "memberships_write" ] }, { "basicAuth": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response.Common.Error.Validation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "description": { "type": "string", "maxLength": 600 }, "imageResource": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "New" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Remove" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Keep" ] } }, "required": [ "type" ] } ] }, "pricesAutomaticallyConverted": { "type": "boolean" }, "askForShippingAddress": { "type": "boolean" }, "monthlyAmounts": { "type": "object", "properties": { "usd": { "type": "integer", "minimum": 100, "maximum": 150000000 }, "eur": { "type": "integer" }, "gbp": { "type": "integer" }, "cad": { "type": "integer" }, "aud": { "type": "integer" }, "nzd": { "type": "integer" }, "sek": { "type": "integer" }, "nok": { "type": "integer" }, "dkk": { "type": "integer" }, "pln": { "type": "integer" }, "jpy": { "type": "integer" }, "myr": { "type": "integer" }, "sgd": { "type": "integer" }, "mxn": { "type": "integer" } }, "required": [ "usd", "eur", "gbp", "cad", "aud", "nzd", "sek", "nok", "dkk", "pln", "jpy", "myr", "sgd", "mxn" ] }, "discount": { "type": "object", "properties": { "percentOff": { "type": "object", "properties": { "monthly": { "type": "integer", "minimum": 0, "maximum": 100 }, "annual": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "monthly" ] }, "timeLimited": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "required": [ "startDate", "endDate" ] } }, "required": [ "percentOff" ] }, "freeTrial": { "type": "boolean" } }, "required": [ "name", "description", "imageResource", "monthlyAmounts" ], "openapi": true } } }, "required": true }, "operationId": "update-tier" } } }, "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "oauth": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth", "scopes": { "memberships_read": "memberships_read", "memberships_write": "memberships_write" } } } } }, "schemas": { "Response.Common.Id": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "title": "Id" }, "Response.Common.Error.Validation": { "type": "object", "properties": { "parameters": { "type": "object", "example": "{ \"post_id\": [ \"is missing\" ] }" }, "body": { "type": "object", "example": "{ \"discount\": { \"percentOff\": [ \"is missing\" ] } }" } }, "title": "Validation" }, "Response.Common.Error.Custom": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "Custom" }, "Request.Common.Id": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "title": "Id" }, "Response.V1.Feed.Post.Text": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "Text" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "pinnedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "path", "access", "notifications", "tags", "statuses", "comments", "likes", "purchaseData" ], "title": "Text" }, "Response.V1.Feed.Post.Poll": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "Poll" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Poll.Option" } }, "votesAmount": { "type": "integer" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "pinnedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "finishedAt", "path", "access", "notifications", "tags", "statuses", "options", "votesAmount", "comments", "likes", "purchaseData" ], "title": "Poll" }, "Response.V1.Feed.Post.Poll.Option": { "type": "object", "properties": { "title": { "type": "string" }, "votes": { "type": "object", "properties": { "amount": { "type": "number" }, "percentage": { "type": "number" } }, "required": [ "amount", "percentage" ] } }, "required": [ "title", "votes" ], "title": "Option" }, "Response.V1.Feed.Post.Audio": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "Audio" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "mediaUrl": { "type": "string" }, "image": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.Custom" }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "pinnedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "path", "access", "notifications", "mediaUrl", "image", "tags", "statuses", "comments", "likes", "purchaseData" ], "title": "Audio" }, "Response.V1.Feed.Post.Audio.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Audio" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "audioDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "imageDirectUploadData", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.Audio.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Audio" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "audioDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.Video": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "Video" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "mediaUrl": { "type": "string" }, "image": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.Custom" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.Mux" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.None" } ] }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "customSubtitles": { "type": "object", "properties": { "filename": { "type": "string" }, "uploadedAt": { "type": "string", "format": "date-time" } }, "required": [ "filename", "uploadedAt" ] }, "autoGeneratedSubtitles": { "type": [ "object", "null" ], "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "countryRestrictions": { "type": "array", "items": { "type": "string" } }, "pinnedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "path", "access", "notifications", "mediaUrl", "tags", "statuses", "comments", "likes", "purchaseData", "customSubtitles", "updatedAt" ], "title": "Video" }, "Response.V1.Feed.Post.Video.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Video" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "videoDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.Video.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Video" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "videoDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.VideoEmbed": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "VideoEmbed" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "embed": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Components.VideoEmbed.Youtube" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Components.VideoEmbed.Streamable" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Components.VideoEmbed.Vimeo" } ] }, "image": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.Custom" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.None" } ] }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "pinnedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "path", "access", "notifications", "embed", "tags", "statuses", "comments", "likes", "purchaseData", "updatedAt" ], "title": "Video Embed" }, "Response.V1.Feed.Post.VideoEmbed.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VideoEmbed" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.VideoEmbed.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VideoEmbed" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.Components.VideoEmbed.Youtube": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Youtube" ] }, "videoId": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "videoId", "url" ], "title": "Youtube" }, "Response.V1.Feed.Post.Components.VideoEmbed.Streamable": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Streamable" ] }, "videoId": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "videoId", "url" ], "title": "Streamable" }, "Response.V1.Feed.Post.Components.VideoEmbed.Vimeo": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Vimeo" ] }, "videoId": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "videoId", "url" ], "title": "Vimeo" }, "Response.V1.Feed.Post.Text.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Text" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.Text.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Text" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.Poll.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Poll" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.Poll.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Poll" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.Image": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "Image" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "liveAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" }, "access": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "type": { "type": "string", "enum": [ "Plans", "MembersOnly", "Public", "FreeMembers", "FreeAndPaidMembers", "Paid", "PaidAndPaidMembers", "PaidAndTiers" ] }, "price": { "type": [ "integer", "null" ] } }, "required": [ "type" ] }, "notifications": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Enabled" }, { "$ref": "#/components/schemas/Response.V1.Feed.Post.Notification.Disabled" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.Common.Id" } }, "imageResources": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.ResourceWithPosition" } }, "image": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Image.Custom" }, "statuses": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Statuses" }, "comments": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Comments" }, "likes": { "$ref": "#/components/schemas/Response.V1.Feed.Post.Likes" }, "purchaseData": { "$ref": "#/components/schemas/Response.V1.Feed.Post.PurchaseData" }, "pinnedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "liveAt", "path", "access", "notifications", "imageResources", "image", "tags", "statuses", "comments", "likes", "purchaseData" ], "title": "Image" }, "Response.V1.Feed.Post.Image.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Image" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "imageDirectUploadData", "postId" ], "title": "Create" }, "Response.V1.Feed.Post.Image.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Image" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "imageDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "uploadUrl", "headers", "signedId" ] }, "postId": { "type": "integer" } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V1.Feed.Post.Statuses": { "type": "object", "properties": { "resources": { "type": "string", "enum": [ "None", "Created", "Processing", "Completed", "Errored" ] }, "post": { "type": "string", "enum": [ "Created", "Ready", "Live", "Finished", "Archived" ] }, "schedule": { "type": "string", "enum": [ "None", "Asap", "Future", "Done" ] } }, "required": [ "resources", "post", "schedule" ], "title": "Statuses" }, "Response.V1.Feed.Post.Comments": { "type": "object", "properties": { "count": { "type": "integer" } }, "required": [ "count" ], "title": "Comments" }, "Response.V1.Feed.Post.Likes": { "type": "object", "properties": { "count": { "type": "integer" } }, "required": [ "count" ], "title": "Likes" }, "Response.V1.Feed.Post.PurchaseData": { "type": "object", "properties": { "purchasesCount": { "type": "integer" } }, "required": [ "purchasesCount" ], "title": "Purchase Data" }, "Response.V1.Feed.Post.Notification.Enabled": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Enabled" ] } }, "required": [ "type" ], "title": "Enabled" }, "Response.V1.Feed.Post.Notification.Disabled": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Disabled" ] } }, "required": [ "type" ], "title": "Disabled" }, "Response.V1.Feed.Post.Image.Custom": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Custom" ] }, "thumbnailUrl": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "thumbnailUrl", "url" ], "title": "Custom" }, "Response.V1.Feed.Post.Image.Mux": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Mux" ] }, "thumbnailUrl": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "thumbnailUrl", "url" ], "title": "Mux" }, "Response.V1.Feed.Post.Image.Embed": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Embed" ] }, "thumbnailUrl": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "thumbnailUrl", "url" ], "title": "Embed" }, "Response.V1.Feed.Post.Image.None": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "None" ] } }, "required": [ "type" ], "title": "None" }, "Response.V1.Feed.Post.Image.ResourceWithPosition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ResourceWithPosition" ] }, "resourceId": { "type": "integer" }, "position": { "type": "integer" } }, "required": [ "type", "resourceId", "position" ], "title": "Resource With Position" }, "Response.V1.Pagination": { "type": "object", "properties": { "pages": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "pages", "limit", "page" ], "title": "Pagination" }, "Response.V1.Resources.Collection": { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Images.Googles.Image" } } }, "required": [ "resources" ], "title": "Collection" }, "Response.V1.Resource.Media": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "title": "Media" }, "Response.V1.Resource.Image.Google.Create": { "type": "object", "properties": { "uploadData": { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "url", "headers", "signedId" ] }, "resourceId": { "type": "integer" } }, "required": [ "uploadData", "resourceId" ], "title": "Create" }, "Response.V1.Images.Googles.Image": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Image" ] }, "provider": { "type": "string", "enum": [ "Google" ] }, "id": { "type": "integer" }, "url": { "type": "string" }, "resizedUrl": { "type": "string" } }, "required": [ "type", "provider", "id", "url", "resizedUrl" ], "title": "Image" }, "Response.V1.Resource.Video.Mux.Direct.Create": { "type": "object", "properties": { "uploadData": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "resourceId": { "type": "integer" } }, "required": [ "uploadData", "resourceId" ], "title": "Create" }, "Response.V1.Resource.Video.Mux.Subtitle.Create": { "type": "object", "properties": { "uploadData": { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object", "properties": { "content-MD5": { "type": "string" }, "content-Disposition": { "type": "string" }, "cache-Control": { "type": "string" } }, "required": [ "content-MD5", "content-Disposition", "cache-Control" ], "example": { "content-MD5": "7vJP+O8buKShZwMbdl7wJQ==", "content-Disposition": "inline; filename=\"7c8f5486-7841-4890-841f-53a3ebe2b445\"; filename*=UTF-8''7c8f5486-7841-4890-841f-53a3ebe2b445", "cache-Control": "public, max-age=2592000" } }, "signedId": { "type": "string" } }, "required": [ "url", "headers", "signedId" ] }, "resourceId": { "type": "integer" } }, "required": [ "uploadData", "resourceId" ], "title": "Create" }, "Response.V1.Resource.Audio.Mux.Direct.Create": { "type": "object", "properties": { "uploadData": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "resourceId": { "type": "integer" } }, "required": [ "uploadData", "resourceId" ], "title": "Create" }, "Response.V2.Tiers.Paid.Collection": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V2.Tiers.Paid" } } }, "required": [ "tiers" ], "title": "Collection" }, "Response.V2.Tiers.Paid": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "position": { "type": "integer" }, "status": { "type": "string", "enum": [ "Published", "Unpublished" ] }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "thumbnailUrl": { "type": "string" } }, "required": [ "url", "thumbnailUrl" ] }, "statistics": { "type": "object", "properties": { "membersCount": { "type": "integer" } }, "required": [ "membersCount" ] }, "pricesAutomaticallyConverted": { "type": "boolean" }, "askForShippingAddress": { "type": "boolean" }, "variants": { "type": "object", "properties": { "monthly": { "type": "object", "properties": { "amounts": { "type": "object", "properties": { "usd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "eur": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "gbp": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "cad": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "aud": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "nzd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "sek": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "nok": { "type": "object", "properties": { "amount": { "type": "float" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "dkk": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "pln": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "jpy": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "myr": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "sgd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "mxn": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] } }, "required": [ "usd", "eur", "gbp", "cad", "aud", "nzd", "sek", "nok", "dkk", "pln", "jpy", "myr", "sgd", "mxn" ] } }, "required": [ "amounts" ] }, "annual": { "type": "object", "properties": { "amounts": { "type": "object", "properties": { "usd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "eur": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "gbp": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "cad": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "aud": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "nzd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "sek": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "nok": { "type": "object", "properties": { "amount": { "type": "float" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "dkk": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "pln": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "jpy": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "myr": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "sgd": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] }, "mxn": { "type": "object", "properties": { "amount": { "type": "integer" }, "locked": { "type": "boolean" }, "setAt": { "type": "string", "format": "date_time" } }, "required": [ "amount", "locked", "setAt" ] } }, "required": [ "usd", "eur", "gbp", "cad", "aud", "nzd", "sek", "nok", "dkk", "pln", "jpy", "myr", "sgd", "mxn" ] }, "constantDiscountPercentageOff": { "type": "integer" } }, "required": [ "amounts", "constantDiscountPercentageOff" ] } }, "required": [ "monthly" ] }, "discount": { "type": "object", "properties": { "percentOff": { "type": "object", "properties": { "monthly": { "type": "integer" }, "annual": { "type": "integer" } }, "required": [ "monthly" ] }, "timeLimited": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } } }, "required": [ "percentOff" ] }, "freeTrial": { "type": "boolean" }, "mobileWlaEnabled": { "type": "boolean" } }, "required": [ "id", "name", "description", "position", "status", "variants", "statistics", "pricesAutomaticallyConverted", "askForShippingAddress", "freeTrial", "mobileWlaEnabled" ], "title": "Paid" }, "Response.V1.Payments.PriceRates.Latest": { "type": "object", "properties": { "usd": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "eur": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "gbp": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "cad": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "aud": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "nzd": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "sek": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "nok": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "dkk": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "pln": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "jpy": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "myr": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "sgd": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] }, "mxn": { "type": "object", "properties": { "amount": { "type": "integer" }, "decimalPlaces": { "type": "integer" } }, "required": [ "amount", "decimalPlaces" ] } }, "required": [ "usd", "eur", "gbp", "cad", "aud", "nzd", "sek", "nok", "dkk", "pln", "jpy", "myr", "sgd", "mxn" ], "title": "Latest" }, "Response.V1.Member.Addresses.Shipping": { "type": "object", "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "vatId": { "type": "string" } }, "required": [ "name", "address1", "city", "country" ], "title": "Shipping" }, "Response.V1.Members": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Member" } }, "pagination": { "$ref": "#/components/schemas/Response.V1.Pagination" } }, "required": [ "members", "pagination" ], "title": "Members" }, "Response.V1.Member.CreatorNotes": { "type": "object", "properties": { "note": { "type": [ "string", "null" ] } }, "required": [], "title": "Creator Notes" }, "Response.V1.Member": { "type": "object", "properties": { "id": { "type": "integer" }, "nickname": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "tier": { "$ref": "#/components/schemas/Response.V1.Member.Tier" }, "state": { "oneOf": [ { "$ref": "#/components/schemas/Response.V1.Member.State.Active" }, { "$ref": "#/components/schemas/Response.V1.Member.State.Expiring" }, { "$ref": "#/components/schemas/Response.V1.Member.State.None" }, { "$ref": "#/components/schemas/Response.V1.Member.State.PastDue" }, { "$ref": "#/components/schemas/Response.V1.Member.State.Former" } ] }, "joinedAt": { "type": "string", "format": "date-time" }, "accountOrigin": { "type": "string", "enum": [ "Checkout", "FreeAccount" ] }, "shadowBanned": { "type": "boolean" }, "conversationId": { "type": "integer" }, "cancelRequest": { "$ref": "#/components/schemas/Response.V1.Member.CancelRequest" }, "badges": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Member.Badges.Badge" } }, "wantsToReceiveBenefits": { "type": "boolean" }, "shippingAddress": { "$ref": "#/components/schemas/Response.V1.Member.Addresses.Shipping" }, "creatorNotes": { "$ref": "#/components/schemas/Response.V1.Member.CreatorNotes" } }, "required": [ "id", "nickname", "email", "state", "joinedAt", "shadowBanned", "cancelRequest", "creatorNotes" ], "title": "Member" }, "Response.V1.Member.Badges.Badge": { "type": "object", "properties": { "id": { "type": "integer" }, "emojiIcon": { "type": "string" }, "icon": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Emoji" ] }, "emojiIcon": { "type": "string" } }, "required": [ "type", "emojiIcon" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ImageResource" ] }, "url": { "type": "string" } }, "required": [ "type", "url" ] } ] }, "text": { "type": "string" }, "textColor": { "type": "string" }, "backgroundColor": { "type": "string" }, "borderColor": { "type": "string" }, "assignedAt": { "type": "string", "format": "date-time" }, "minimal": { "type": "boolean" } }, "required": [ "id", "icon", "text", "assignedAt", "minimal" ], "title": "Badge" }, "Response.V1.Member.Tier": { "type": "object", "properties": { "name": { "type": "string" }, "billingCycle": { "type": "string", "enum": [ "Monthly", "Annual" ] }, "askForShippingAddress": { "type": "boolean" } }, "required": [ "name", "billingCycle", "askForShippingAddress" ], "title": "Tier" }, "Response.V1.Member.State.Active": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Active" ] }, "subscribedAt": { "type": "string", "format": "date-time" }, "freeTrialEndsAt": { "type": "string", "format": "date-time" } }, "required": [ "subscribedAt" ], "title": "Active" }, "Response.V1.Member.State.Expiring": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Expiring" ] }, "subscribedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "freeTrialEndsAt": { "type": "string", "format": "date-time" } }, "required": [ "subscribedAt", "expiresAt" ], "title": "Expiring" }, "Response.V1.Member.State.Former": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Former" ] }, "subscribedAt": { "type": "string", "format": "date-time" }, "expiredAt": { "type": "string", "format": "date-time" } }, "required": [ "subscribedAt", "expiredAt" ], "title": "Former" }, "Response.V1.Member.State.None": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "None" ] } }, "title": "None" }, "Response.V1.Member.State.PastDue": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PastDue" ] }, "subscribedAt": { "type": "string", "format": "date-time" }, "previousPeriodEnd": { "type": "string", "format": "date-time" } }, "required": [ "subscribedAt", "previousPeriodEnd" ], "title": "Past Due" }, "Response.V1.Member.CancelRequest": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Allowed" ] }, "subscriptionCurrentPeriodEnd": { "type": "string", "format": "date-time" } }, "required": [ "type", "subscriptionCurrentPeriodEnd" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Disabled" ] }, "reason": { "type": "string", "enum": [ "SubscriptionNotActive", "AlreadyRequested", "IapSubscription" ] } }, "required": [ "type", "reason" ] } ], "title": "Cancel Request" }, "Response.V1.Members.ExitSurveys": { "type": "object", "properties": { "exitSurveys": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Member.ExitSurvey" } } }, "required": [ "exitSurveys" ], "title": "Exit Surveys" }, "Response.V1.Member.ExitSurvey": { "type": "object", "properties": { "id": { "type": "integer" }, "reasons": { "type": "array", "items": { "type": "string" } }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "reasons", "updatedAt" ], "title": "Exit Survey" }, "Response.V1.Member.Charges.Subscription": { "type": "object", "properties": { "id": { "type": "integer" }, "amount": { "type": "integer" }, "currency": { "type": "object", "properties": { "code": { "type": "string" }, "decimalPlaces": { "type": "integer" } }, "required": [ "code", "decimalPlaces" ] }, "createdAt": { "type": "string", "format": "date-time" }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "amount" ] } }, "refundRequest": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Disabled" ] }, "reason": { "type": "string", "enum": [ "AlreadyRefunded", "TooSmallAmount", "IapCharge", "TooOldPayPalCharge" ] } }, "required": [ "type", "reason" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Allowed" ] }, "options": { "type": "object", "properties": { "full": { "type": "object", "properties": { "amount": { "type": "integer" } }, "required": [ "amount" ] }, "prorated": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Allowed" ] }, "amount": { "type": "integer" }, "daysLeft": { "type": "integer" }, "daysTotal": { "type": "integer" } }, "required": [ "type", "amount", "daysLeft", "daysTotal" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Disabled" ] }, "amount": { "type": "integer" }, "daysLeft": { "type": "integer" }, "daysTotal": { "type": "integer" }, "reason": { "type": "string", "enum": [ [ "TooSmallAmount", "AmountGreaterThanChargeAmount" ] ] } }, "required": [ "type", "amount", "daysLeft", "daysTotal", "reason" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NotAllowed" ] }, "reason": { "type": "string", "enum": [ [ "NotLastCharge", "SubscriptionNotActive" ] ] } }, "required": [ "type", "reason" ] } ] }, "custom": { "type": "object", "properties": { "minAmount": { "type": "integer" }, "maxAmount": { "type": "integer" } }, "required": [ "minAmount", "maxAmount" ] } }, "required": [ "full", "prorated", "custom" ] } }, "required": [ "type", "options" ] } ] } }, "required": [ "id", "amount", "currency", "createdAt", "refunds", "refundRequest" ], "title": "Subscription" }, "Response.V1.Member.Charges.Subscriptions": { "type": "object", "properties": { "charges": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Member.Charges.Subscription" } }, "pagination": { "$ref": "#/components/schemas/Response.V1.Pagination" } }, "required": [ "charges", "pagination" ], "title": "Subscriptions" }, "Response.V1.Tag.Posts": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V1.Tag.PostWithPosts" } }, "pagination": { "$ref": "#/components/schemas/Response.V1.Pagination" } }, "required": [ "tags", "pagination" ], "title": "Posts" }, "Response.V1.Tag.Post": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "title": "Post" }, "Response.V1.Tag.PostWithPosts": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "postsCount": { "type": "integer" }, "thumbnail": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "required": [ "id", "name", "postsCount" ], "title": "Post With Posts" }, "Response.V1.Tag.PostWithPostsIds": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "postsIds": { "type": "array", "items": { "type": "integer" } }, "thumbnail": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "required": [ "id", "name", "postsIds" ], "title": "Post With Posts Ids" }, "Response.V2.Post.Audio.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Audio" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "postId": { "type": "integer" }, "audioDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V2.Post.Audio.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Audio" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "postId": { "type": "integer" }, "audioDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V2.Post.Video.Create": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Video" ] }, "action": { "type": "string", "enum": [ "Create" ] }, "postId": { "type": "integer" }, "videoDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] } }, "required": [ "type", "action", "postId" ], "title": "Create" }, "Response.V2.Post.Video.Update": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Video" ] }, "action": { "type": "string", "enum": [ "Update" ] }, "postId": { "type": "integer" }, "videoDirectUploadData": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": [ "uploadUrl" ] } }, "required": [ "type", "action", "postId" ], "title": "Update" }, "Response.V2.Pagination": { "type": "object", "properties": { "pages": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "pages", "limit", "page", "total" ], "title": "Pagination" }, "Response.V2.Series.Post": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "postsType": { "type": "string", "enum": [ "video", "audio" ] }, "coverImage": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "thumbnail": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] }, "episodesCount": { "type": "integer" }, "postsIds": { "type": "array", "items": { "type": "integer" } } }, "required": [ "id", "title", "postsType", "episodesCount", "postsIds" ], "title": "Post" }, "Response.V2.Series.Posts": { "type": "object", "properties": { "series": { "type": "array", "items": { "$ref": "#/components/schemas/Response.V2.Series.Post" } }, "pagination": { "$ref": "#/components/schemas/Response.V2.Pagination" } }, "required": [ "series", "pagination" ], "title": "Posts" } } } }