paid_ruby 0.1.0

data/lib/paid_ruby/types/agent_attribute.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require_relative "pricing"
+require "ostruct"
+require "json"
+
+module Paid
+  class AgentAttribute
+  # @return [String] 
+    attr_reader :name
+  # @return [Boolean] 
+    attr_reader :active
+  # @return [Paid::Pricing] 
+    attr_reader :pricing
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] 
+    # @param active [Boolean] 
+    # @param pricing [Paid::Pricing] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::AgentAttribute]
+    def initialize(name:, active:, pricing:, additional_properties: nil)
+      @name = name
+      @active = active
+      @pricing = pricing
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "active": active, "pricing": pricing }
+    end
+# Deserialize a JSON object to an instance of AgentAttribute
+    #
+    # @param json_object [String] 
+    # @return [Paid::AgentAttribute]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      active = parsed_json["active"]
+      unless parsed_json["pricing"].nil?
+        pricing = parsed_json["pricing"].to_json
+        pricing = Paid::Pricing.from_json(json_object: pricing)
+      else
+        pricing = nil
+      end
+      new(
+        name: name,
+        active: active,
+        pricing: pricing,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AgentAttribute to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.active.is_a?(Boolean) != false || raise("Passed value for field obj.active is not the expected type, validation failed.")
+      Paid::Pricing.validate_raw(obj: obj.pricing)
+    end
+  end
+end

data/lib/paid_ruby/types/agent_price_point.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require_relative "agent_price_point_tiers"
+require "ostruct"
+require "json"
+
+module Paid
+  class AgentPricePoint
+  # @return [Float] 
+    attr_reader :unit_price
+  # @return [Float] 
+    attr_reader :min_quantity
+  # @return [Float] 
+    attr_reader :included_quantity
+  # @return [Array<Paid::AgentPricePointTiers>] 
+    attr_reader :tiers
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param unit_price [Float] 
+    # @param min_quantity [Float] 
+    # @param included_quantity [Float] 
+    # @param tiers [Array<Paid::AgentPricePointTiers>] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::AgentPricePoint]
+    def initialize(unit_price: OMIT, min_quantity: OMIT, included_quantity: OMIT, tiers: OMIT, additional_properties: nil)
+      @unit_price = unit_price if unit_price != OMIT
+      @min_quantity = min_quantity if min_quantity != OMIT
+      @included_quantity = included_quantity if included_quantity != OMIT
+      @tiers = tiers if tiers != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "unitPrice": unit_price, "minQuantity": min_quantity, "includedQuantity": included_quantity, "tiers": tiers }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of AgentPricePoint
+    #
+    # @param json_object [String] 
+    # @return [Paid::AgentPricePoint]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      unit_price = parsed_json["unitPrice"]
+      min_quantity = parsed_json["minQuantity"]
+      included_quantity = parsed_json["includedQuantity"]
+      tiers = parsed_json["tiers"]&.map do | item |
+  item = item.to_json
+  Paid::AgentPricePointTiers.from_json(json_object: item)
+end
+      new(
+        unit_price: unit_price,
+        min_quantity: min_quantity,
+        included_quantity: included_quantity,
+        tiers: tiers,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AgentPricePoint to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.unit_price&.is_a?(Float) != false || raise("Passed value for field obj.unit_price is not the expected type, validation failed.")
+      obj.min_quantity&.is_a?(Float) != false || raise("Passed value for field obj.min_quantity is not the expected type, validation failed.")
+      obj.included_quantity&.is_a?(Float) != false || raise("Passed value for field obj.included_quantity is not the expected type, validation failed.")
+      obj.tiers&.is_a?(Array) != false || raise("Passed value for field obj.tiers is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/paid_ruby/types/agent_price_point_tiers.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Paid
+  class AgentPricePointTiers
+  # @return [Float] 
+    attr_reader :min_quantity
+  # @return [Float] 
+    attr_reader :max_quantity
+  # @return [Float] 
+    attr_reader :unit_price
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param min_quantity [Float] 
+    # @param max_quantity [Float] 
+    # @param unit_price [Float] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::AgentPricePointTiers]
+    def initialize(min_quantity: OMIT, max_quantity: OMIT, unit_price:, additional_properties: nil)
+      @min_quantity = min_quantity if min_quantity != OMIT
+      @max_quantity = max_quantity if max_quantity != OMIT
+      @unit_price = unit_price
+      @additional_properties = additional_properties
+      @_field_set = { "minQuantity": min_quantity, "maxQuantity": max_quantity, "unitPrice": unit_price }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of AgentPricePointTiers
+    #
+    # @param json_object [String] 
+    # @return [Paid::AgentPricePointTiers]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      min_quantity = parsed_json["minQuantity"]
+      max_quantity = parsed_json["maxQuantity"]
+      unit_price = parsed_json["unitPrice"]
+      new(
+        min_quantity: min_quantity,
+        max_quantity: max_quantity,
+        unit_price: unit_price,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AgentPricePointTiers to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.min_quantity&.is_a?(Float) != false || raise("Passed value for field obj.min_quantity is not the expected type, validation failed.")
+      obj.max_quantity&.is_a?(Float) != false || raise("Passed value for field obj.max_quantity is not the expected type, validation failed.")
+      obj.unit_price.is_a?(Float) != false || raise("Passed value for field obj.unit_price is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/paid_ruby/types/agent_update.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+require_relative "agent_attribute"
+require "ostruct"
+require "json"
+
+module Paid
+  class AgentUpdate
+  # @return [String] 
+    attr_reader :name
+  # @return [String] 
+    attr_reader :description
+  # @return [String] 
+    attr_reader :external_id
+  # @return [Boolean] 
+    attr_reader :active
+  # @return [String] 
+    attr_reader :agent_code
+  # @return [Array<Paid::AgentAttribute>] 
+    attr_reader :agent_attributes
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] 
+    # @param description [String] 
+    # @param external_id [String] 
+    # @param active [Boolean] 
+    # @param agent_code [String] 
+    # @param agent_attributes [Array<Paid::AgentAttribute>] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::AgentUpdate]
+    def initialize(name: OMIT, description: OMIT, external_id: OMIT, active: OMIT, agent_code: OMIT, agent_attributes: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @description = description if description != OMIT
+      @external_id = external_id if external_id != OMIT
+      @active = active if active != OMIT
+      @agent_code = agent_code if agent_code != OMIT
+      @agent_attributes = agent_attributes if agent_attributes != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "description": description, "externalId": external_id, "active": active, "agentCode": agent_code, "agentAttributes": agent_attributes }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of AgentUpdate
+    #
+    # @param json_object [String] 
+    # @return [Paid::AgentUpdate]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      external_id = parsed_json["externalId"]
+      active = parsed_json["active"]
+      agent_code = parsed_json["agentCode"]
+      agent_attributes = parsed_json["agentAttributes"]&.map do | item |
+  item = item.to_json
+  Paid::AgentAttribute.from_json(json_object: item)
+end
+      new(
+        name: name,
+        description: description,
+        external_id: external_id,
+        active: active,
+        agent_code: agent_code,
+        agent_attributes: agent_attributes,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AgentUpdate to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
+      obj.active&.is_a?(Boolean) != false || raise("Passed value for field obj.active is not the expected type, validation failed.")
+      obj.agent_code&.is_a?(String) != false || raise("Passed value for field obj.agent_code is not the expected type, validation failed.")
+      obj.agent_attributes&.is_a?(Array) != false || raise("Passed value for field obj.agent_attributes is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/paid_ruby/types/api_error.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Paid
+# An API error response from the Paid API
+  class ApiError
+  # @return [String] A human-readable message providing more details about the error.
+    attr_reader :message
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param message [String] A human-readable message providing more details about the error.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::ApiError]
+    def initialize(message: OMIT, additional_properties: nil)
+      @message = message if message != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "message": message }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of ApiError
+    #
+    # @param json_object [String] 
+    # @return [Paid::ApiError]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      message = parsed_json["message"]
+      new(message: message, additional_properties: struct)
+    end
+# Serialize an instance of ApiError to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/paid_ruby/types/billing_frequency.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Paid
+  class BillingFrequency
+
+    MONTHLY = "Monthly"
+    QUARTERLY = "Quarterly"
+    ANNUAL = "Annual"
+
+  end
+end

data/lib/paid_ruby/types/charge_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Paid
+  class ChargeType
+
+    ONE_TIME = "oneTime"
+    RECURRING = "recurring"
+    USAGE = "usage"
+    SEAT_BASED = "seatBased"
+
+  end
+end

data/lib/paid_ruby/types/contact.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+require_relative "salutation"
+require "ostruct"
+require "json"
+
+module Paid
+  class Contact
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :external_id
+  # @return [String] 
+    attr_reader :organization_id
+  # @return [String] 
+    attr_reader :customer_id
+  # @return [String] 
+    attr_reader :customer_external_id
+  # @return [Paid::Salutation] 
+    attr_reader :salutation
+  # @return [String] 
+    attr_reader :first_name
+  # @return [String] 
+    attr_reader :last_name
+  # @return [String] 
+    attr_reader :email
+  # @return [String] 
+    attr_reader :phone
+  # @return [String] 
+    attr_reader :billing_street
+  # @return [String] 
+    attr_reader :billing_city
+  # @return [String] 
+    attr_reader :billing_state_province
+  # @return [String] 
+    attr_reader :billing_country
+  # @return [String] 
+    attr_reader :billing_postal_code
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param external_id [String] 
+    # @param organization_id [String] 
+    # @param customer_id [String] 
+    # @param customer_external_id [String] 
+    # @param salutation [Paid::Salutation] 
+    # @param first_name [String] 
+    # @param last_name [String] 
+    # @param email [String] 
+    # @param phone [String] 
+    # @param billing_street [String] 
+    # @param billing_city [String] 
+    # @param billing_state_province [String] 
+    # @param billing_country [String] 
+    # @param billing_postal_code [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Paid::Contact]
+    def initialize(id: OMIT, external_id: OMIT, organization_id: OMIT, customer_id: OMIT, customer_external_id: OMIT, salutation: OMIT, first_name: OMIT, last_name: OMIT, email: OMIT, phone: OMIT, billing_street: OMIT, billing_city: OMIT, billing_state_province: OMIT, billing_country: OMIT, billing_postal_code: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
+      @external_id = external_id if external_id != OMIT
+      @organization_id = organization_id if organization_id != OMIT
+      @customer_id = customer_id if customer_id != OMIT
+      @customer_external_id = customer_external_id if customer_external_id != OMIT
+      @salutation = salutation if salutation != OMIT
+      @first_name = first_name if first_name != OMIT
+      @last_name = last_name if last_name != OMIT
+      @email = email if email != OMIT
+      @phone = phone if phone != OMIT
+      @billing_street = billing_street if billing_street != OMIT
+      @billing_city = billing_city if billing_city != OMIT
+      @billing_state_province = billing_state_province if billing_state_province != OMIT
+      @billing_country = billing_country if billing_country != OMIT
+      @billing_postal_code = billing_postal_code if billing_postal_code != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "externalId": external_id, "organizationId": organization_id, "customerId": customer_id, "customerExternalId": customer_external_id, "salutation": salutation, "firstName": first_name, "lastName": last_name, "email": email, "phone": phone, "billingStreet": billing_street, "billingCity": billing_city, "billingStateProvince": billing_state_province, "billingCountry": billing_country, "billingPostalCode": billing_postal_code }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of Contact
+    #
+    # @param json_object [String] 
+    # @return [Paid::Contact]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      external_id = parsed_json["externalId"]
+      organization_id = parsed_json["organizationId"]
+      customer_id = parsed_json["customerId"]
+      customer_external_id = parsed_json["customerExternalId"]
+      salutation = parsed_json["salutation"]
+      first_name = parsed_json["firstName"]
+      last_name = parsed_json["lastName"]
+      email = parsed_json["email"]
+      phone = parsed_json["phone"]
+      billing_street = parsed_json["billingStreet"]
+      billing_city = parsed_json["billingCity"]
+      billing_state_province = parsed_json["billingStateProvince"]
+      billing_country = parsed_json["billingCountry"]
+      billing_postal_code = parsed_json["billingPostalCode"]
+      new(
+        id: id,
+        external_id: external_id,
+        organization_id: organization_id,
+        customer_id: customer_id,
+        customer_external_id: customer_external_id,
+        salutation: salutation,
+        first_name: first_name,
+        last_name: last_name,
+        email: email,
+        phone: phone,
+        billing_street: billing_street,
+        billing_city: billing_city,
+        billing_state_province: billing_state_province,
+        billing_country: billing_country,
+        billing_postal_code: billing_postal_code,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of Contact to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
+      obj.organization_id&.is_a?(String) != false || raise("Passed value for field obj.organization_id is not the expected type, validation failed.")
+      obj.customer_id&.is_a?(String) != false || raise("Passed value for field obj.customer_id is not the expected type, validation failed.")
+      obj.customer_external_id&.is_a?(String) != false || raise("Passed value for field obj.customer_external_id is not the expected type, validation failed.")
+      obj.salutation&.is_a?(Paid::Salutation) != false || raise("Passed value for field obj.salutation is not the expected type, validation failed.")
+      obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+      obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+      obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+      obj.phone&.is_a?(String) != false || raise("Passed value for field obj.phone is not the expected type, validation failed.")
+      obj.billing_street&.is_a?(String) != false || raise("Passed value for field obj.billing_street is not the expected type, validation failed.")
+      obj.billing_city&.is_a?(String) != false || raise("Passed value for field obj.billing_city is not the expected type, validation failed.")
+      obj.billing_state_province&.is_a?(String) != false || raise("Passed value for field obj.billing_state_province is not the expected type, validation failed.")
+      obj.billing_country&.is_a?(String) != false || raise("Passed value for field obj.billing_country is not the expected type, validation failed.")
+      obj.billing_postal_code&.is_a?(String) != false || raise("Passed value for field obj.billing_postal_code is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/paid_ruby/types/creation_source.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Paid
+  class CreationSource
+
+    MANUAL = "manual"
+    API = "api"
+    CRM = "crm"
+    OTHER = "other"
+
+  end
+end

data/lib/paid_ruby/types/creation_state.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Paid
+  class CreationState
+
+    ACTIVE = "active"
+    DRAFT = "draft"
+
+  end
+end