Class: Opendoor::PartnerSdk::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/opendoor/partner_sdk/client.rb

Constant Summary collapse

VALID_OFFER_INPUT_FIELDS = 
%w[
  sellerEmail sellerFullName sellerPhoneNumber sellerRelationToOwner sellerWorkingWithHomeBuilder
  sellerSaleTimeline homeDwellingType homeBedrooms homeBathroomsFull homeBathroomsPartial homeYearBuilt
  homeExteriorStories homeAboveGradeSqFt homeCoveredParkingType homeGarageSpaces homeCarportSpaces
  homePoolType homeHasBasement homeBasementFinishedSqFt homeBasementUnfinishedSqFt homeKitchenCounterType
  homeHoa homeHoaTypeAgeRestrictedCommunity homeHoaTypeGatedCommunity homeHoaTypeGuardedGatedCommunity
  homeEntryType homeKitchenCondition homeBathroomCondition homeLivingRoomCondition homeExteriorCondition
  homeEligibilityCriteriaLeasedSolarPanels homeEligibilityCriteriaKnownFoundationIssues homeEligibilityCriteriaFireDamage
  homeEligibilityCriteriaWellWater homeEligibilityCriteriaSeptic homeEligibilityCriteriaAsbestosSiding
  homeEligibilityCriteriaLivestock homeEligibilityCriteriaMobileManufacturedHome homeEligibilityCriteriaUniqueOwnershipStructure
  homeEligibilityCriteriaBelowMarketRateOwnership homeEligibilityCriteriaRentControlledTenantOccupied homeHoaFees
  homeHasUpgrades sellerSmsOptIn correlationId experimental
].to_set.freeze
ENUM_FIELDS = 
%w[
  homeDwellingType homeCoveredParkingType homePoolType homeEntryType homeKitchenCounterType
  homeKitchenCondition homeBathroomCondition homeLivingRoomCondition homeExteriorCondition sellerRelationToOwner
].to_set.freeze
ENDPOINTS = 
{
  production: {
    api_endpoint: "https://partner.opendoor.com/api/graphql",
    address_endpoint: "https://www.opendoor.com",
    gateway_endpoint: "https://graphql.opendoor.com/api/graphql"
  },
  staging: {
    api_endpoint: "https://partner.simplersell.com/api/graphql",
    address_endpoint: "https://demo.simplersell.com",
    gateway_endpoint: "https://graphql.simplersell.com/api/graphql"
  }
}.freeze
DEFAULT_TIMEOUT_MS =

Matches server-js-core: request timeout in milliseconds (see OpendoorClientConfig.timeout).

30_000

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, environment: :staging, timeout: DEFAULT_TIMEOUT_MS, debug: false, api_endpoint: nil, address_endpoint: nil, gateway_endpoint: nil) ⇒ Client

Returns a new instance of Client.

Raises:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/opendoor/partner_sdk/client.rb', line 45

def initialize(api_key:, environment: :staging, timeout: DEFAULT_TIMEOUT_MS, debug: false, api_endpoint: nil, address_endpoint: nil, gateway_endpoint: nil)
  raise ValidationError.new("apiKey is required", "apiKey") if blank?(api_key)

  env = environment.to_sym
  endpoints = ENDPOINTS.fetch(env)

  @api_key = api_key
  @api_endpoint = api_endpoint || endpoints[:api_endpoint]
  @address_endpoint = address_endpoint || endpoints[:address_endpoint]
  @gateway_endpoint = gateway_endpoint || endpoints[:gateway_endpoint]
  @timeout_ms = timeout
  # Net::HTTP expects seconds (fractional allowed); keep parity with JS ms default.
  @timeout_seconds = [@timeout_ms / 1000.0, 0.001].max
  @debug = debug
end

Instance Method Details

#check_address_unit(address:) ⇒ Object

Raises:



162
163
164
165
166
167
168
169
170
 
# File 'lib/opendoor/partner_sdk/client.rb', line 162

def check_address_unit(address:)
  raise ValidationError.new("street1 is required", "street1") if blank?(get(address, :street1))

  result = graphql(
    query: Graphql::ADDRESS_UNIT_CHECK,
    variables: { address: normalize_address(address) }
  )
  symbolize_keys(result.fetch("addressUnitCheck"))
end

#create_offer(data:) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/opendoor/partner_sdk/client.rb', line 85

def create_offer(data:)
  Validators.validate_create_offer_request(data)
  address = get(data, :address)

  result = graphql(
    query: Graphql::OFFER_REQUEST_CREATE,
    variables: {
      offerRequestCreateInput: {
        address: normalize_address(address),
        saleAssociateEmail: get(data, :sales_associate_email, :salesAssociateEmail),
        saleAssociateName: get(data, :sales_associate_name, :salesAssociateName)
      }.compact
    }
  )

  symbolize_keys(result.fetch("offerRequestCreate").fetch("offerRequest"))
end

#get_address_details(address:, tracking_id: nil) ⇒ Object

Raises:



172
173
174
175
176
177
178
179
180
 
# File 'lib/opendoor/partner_sdk/client.rb', line 172

def get_address_details(address:, tracking_id: nil)
  raise ValidationError.new("street1 is required", "street1") if blank?(get(address, :street1))

  variables = { address: normalize_address(address) }
  variables[:trackingId] = tracking_id if tracking_id

  result = graphql(query: Graphql::ADDRESS_DETAILS_QUERY, variables: variables)
  symbolize_keys(result.fetch("address"))
end

#get_address_suggestions(query:) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/opendoor/partner_sdk/client.rb', line 61

def get_address_suggestions(query:)
  return { addresses: [] } if blank?(query)

  session_token = SecureRandom.uuid
  params = URI.encode_www_form(query: query, sessionToken: session_token)
  url = "#{@address_endpoint}/_address-input/autocomplete?#{params}"
  log("REST GET -> #{@address_endpoint}/_address-input/autocomplete")

  response = fetch_with_timeout(url, method: :get, headers: { "Content-Type" => "application/json" })
  ensure_ok!(response, "Autocomplete request failed", "NETWORK_ERROR")

  raw = parse_json_response(response.body, http_status: response.code.to_i)
  predictions = raw.fetch("predictions", [])
  addresses = predictions.map do |prediction|
    begin
      resolve_prediction(prediction, session_token)
    rescue StandardError
      nil
    end
  end.compact

  { addresses: addresses }
end

#get_assessment_slots(offer_id:) ⇒ Object

Raises:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/opendoor/partner_sdk/client.rb', line 217

def get_assessment_slots(offer_id:)
  raise ValidationError.new("offerId is required", "offerId") if blank?(offer_id)

  api_base = graphql_api_origin
  url = "#{api_base}/v2/exterior_assessment_slots"
  log("REST POST -> #{url}")

  response = fetch_with_timeout(
    url,
    method: :post,
    headers: {
      "Content-Type" => "application/json",
      "Authorization" => "Basic #{@api_key}"
    },
    body: JSON.generate(
      partnerId: @api_key,
      sellerInputUuid: offer_id,
      calendarType: "DILIGENCE_VISIT"
    )
  )
  ensure_ok!(response, "Assessment slots request failed", "NETWORK_ERROR")
  raw = parse_json_response(response.body, http_status: response.code.to_i)

  unless raw["success"]
    raise ApiError.new(raw["error"] || "Assessment slots request failed", "API_ERROR", 200)
  end

  {
    currentInspectionTime: raw["currentInspectionTime"],
    availableSlots: raw["availableSlots"] || [],
    isSlotBased: raw["isSlotBased"] || false,
    visitId: raw["visitId"] || "",
    timezone: raw["timezone"] || "UTC"
  }
end

#get_home_detail(opendoor_offer_request_id:) ⇒ Object

Raises:



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/opendoor/partner_sdk/client.rb', line 253

def get_home_detail(opendoor_offer_request_id:)
  raise ValidationError.new("opendoorOfferRequestId is required", "opendoorOfferRequestId") if blank?(opendoor_offer_request_id)

  data = graphql(
    query: Graphql::SELLER_INPUT_PREFILLS_QUERY,
    variables: { sellerInputUuid: opendoor_offer_request_id }
  )

  seller_prefills = data["sellerInputPrefills"]
  raise ApiError.new("Home detail not found", "NOT_FOUND", 404) if seller_prefills.nil?

  { answerPrefills: seller_prefills["answerPrefills"] || {} }
end

#get_homebuilders ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/opendoor/partner_sdk/client.rb', line 182

def get_homebuilders
  log("GraphQL (gateway) -> #{@gateway_endpoint}")
  response = fetch_with_timeout(
    @gateway_endpoint,
    method: :post,
    headers: {
      "Content-Type" => "application/json",
      "apollographql-client-name" => "partner-sdk",
      "apollographql-client-version" => "1.0"
    },
    body: JSON.generate(
      query: Graphql::LIST_PARTNERS_QUERY,
      variables: { partnershipType: "HOME_BUILDER" }
    )
  )

  ensure_ok!(response, "Homebuilders request failed", "GRAPHQL_ERROR")
  json = parse_json_response(response.body, http_status: response.code.to_i)
  ensure_graphql_data!(json)

  partners = json.dig("data", "partnership", "listPartners", "partners")
  unless partners.is_a?(Array)
    raise ApiError.new("GraphQL response missing partnership.listPartners.partners", "GRAPHQL_ERROR", 200)
  end

  {
    homebuilders: partners.map do |partner|
      {
        identifier: partner["identifier"],
        displayName: partner["displayName"]
      }
    end
  }
end

#get_offer(offer_id:) ⇒ Object

Raises:



132
133
134
135
136
137
138
139
140
 
# File 'lib/opendoor/partner_sdk/client.rb', line 132

def get_offer(offer_id:)
  raise ValidationError.new("offerId is required", "offerId") if blank?(offer_id)

  result = graphql(
    query: Graphql::OFFER_REQUEST_QUERY,
    variables: { opendoorOfferRequestId: offer_id }
  )
  symbolize_keys(result.fetch("offerRequest"))
end

#get_offer_with_products_pricing(offer_id:) ⇒ Object

Raises:



152
153
154
155
156
157
158
159
160
 
# File 'lib/opendoor/partner_sdk/client.rb', line 152

def get_offer_with_products_pricing(offer_id:)
  raise ValidationError.new("offerId is required", "offerId") if blank?(offer_id)

  result = graphql(
    query: Graphql::OFFER_REQUEST_WITH_PRODUCTS_PRICING,
    variables: { opendoorOfferRequestId: offer_id }
  )
  symbolize_keys(result.fetch("offerRequestWithProductsPricing"))
end

#get_offer_with_sell_direct_pricing(offer_id:) ⇒ Object

Raises:



142
143
144
145
146
147
148
149
150
 
# File 'lib/opendoor/partner_sdk/client.rb', line 142

def get_offer_with_sell_direct_pricing(offer_id:)
  raise ValidationError.new("offerId is required", "offerId") if blank?(offer_id)

  result = graphql(
    query: Graphql::OFFER_REQUEST_WITH_SELL_DIRECT_PRICING,
    variables: { opendoorOfferRequestId: offer_id }
  )
  symbolize_keys(result.fetch("offerRequestWithSellDirectPricing"))
end

#update_offer(offer_id:, data:) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/opendoor/partner_sdk/client.rb', line 103

def update_offer(offer_id:, data:)
  Validators.validate_update_offer_request(offer_id, data)
  transformed = AnswerKeyMapping.transform_answers_to_offer_input(stringify_keys(data))
  offer_input = {}

  transformed.each do |key, value|
    next if value.nil?
    next unless VALID_OFFER_INPUT_FIELDS.include?(key)

    offer_input[key] = if value.is_a?(String) && ENUM_FIELDS.include?(key)
                         value.upcase
                       else
                         value
                       end
  end

  result = graphql(
    query: Graphql::OFFER_REQUEST_UPDATE,
    variables: {
      offerRequestUpdateInput: {
        opendoorOfferRequestId: offer_id,
        offerInput: offer_input
      }
    }
  )

  symbolize_keys(result.fetch("offerRequestUpdate").fetch("offerRequest"))
end