| GET | /sales/members/{MemberId}/package-eligibility | Find out is a user is eligible to purchase a certain package. |
|---|
import Foundation
import ServiceStack
public class PackageEligibilityRequest : PackageEligibilityRequestDto, IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
// @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
public var apiKey:String
/**
* Store ID # member belongs to
*/
// @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
public var storeId:Int?
/**
* ID of the member to lookup
*/
// @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
public var memberId:Int
/**
* ID of the package to check
*/
// @ApiMember(DataType="integer", Description="ID of the package to check", IsRequired=true, Name="PackageId", ParameterType="query")
public var packageId:Int
public var restrictedId:Int?
public var restrictedResourceType:RestrictedResourceType
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case apiKey
case storeId
case memberId
case packageId
case restrictedId
case restrictedResourceType
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
memberId = try container.decodeIfPresent(Int.self, forKey: .memberId)
packageId = try container.decodeIfPresent(Int.self, forKey: .packageId)
restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
if storeId != nil { try container.encode(storeId, forKey: .storeId) }
if memberId != nil { try container.encode(memberId, forKey: .memberId) }
if packageId != nil { try container.encode(packageId, forKey: .packageId) }
if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
}
}
public class PackageEligibilityRequestDto : ApiDtoBase
{
public var packageId:Int
public var memberId:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case packageId
case memberId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
packageId = try container.decodeIfPresent(Int.self, forKey: .packageId)
memberId = try container.decodeIfPresent(Int.self, forKey: .memberId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if packageId != nil { try container.encode(packageId, forKey: .packageId) }
if memberId != nil { try container.encode(memberId, forKey: .memberId) }
}
}
public class ApiDtoBase : Codable
{
public var apiKey:String
public var storeId:Int?
public var chainId:Int?
required public init(){}
}
public enum RestrictedResourceType : String, Codable
{
case Store
case Chain
case User
case Undefined
}
public class PackageEligibilityResponse : PackageEligibilityResponseDto
{
public var eligibilityInfo:PackageEligibility
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case eligibilityInfo
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
eligibilityInfo = try container.decodeIfPresent(PackageEligibility.self, forKey: .eligibilityInfo)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if eligibilityInfo != nil { try container.encode(eligibilityInfo, forKey: .eligibilityInfo) }
}
}
public class PackageEligibilityResponseDto : ApiResponseBase
{
public var eligibilityInfo:PackageEligibility
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case eligibilityInfo
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
eligibilityInfo = try container.decodeIfPresent(PackageEligibility.self, forKey: .eligibilityInfo)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if eligibilityInfo != nil { try container.encode(eligibilityInfo, forKey: .eligibilityInfo) }
}
}
public class ApiResponseBase : Codable
{
public var success:Bool
public var message:String
required public init(){}
}
public class PackageEligibility : Codable
{
public var isEligible:Bool
public var eligibility:[PackageEligibilityItem] = []
required public init(){}
}
public class PackageEligibilityItem : Codable
{
public var name:String
public var value:String
public var isEligible:Bool
public var message:String
required public init(){}
}
Swift PackageEligibilityRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sales/members/{MemberId}/package-eligibility HTTP/1.1
Host: clubready.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
EligibilityInfo:
{
IsEligible: False,
Eligibility:
[
{
Name: String,
Value: String,
IsEligible: False,
Message: String
}
]
},
Success: False,
Message: String
}